diff options
| -rw-r--r-- | doc/weechat_doc_en.texi | 2914 | ||||
| -rw-r--r-- | doc/weechat_doc_es.texi | 2911 | ||||
| -rw-r--r-- | doc/weechat_doc_fr.texi | 2955 | ||||
| -rw-r--r-- | doc/weechat_doc_pt.texi | 2907 | ||||
| -rw-r--r-- | weechat/doc/weechat_doc_en.texi | 2914 | ||||
| -rw-r--r-- | weechat/doc/weechat_doc_es.texi | 2911 | ||||
| -rw-r--r-- | weechat/doc/weechat_doc_fr.texi | 2955 | ||||
| -rw-r--r-- | weechat/doc/weechat_doc_pt.texi | 2907 |
8 files changed, 0 insertions, 23374 deletions
diff --git a/doc/weechat_doc_en.texi b/doc/weechat_doc_en.texi deleted file mode 100644 index 115c46c05..000000000 --- a/doc/weechat_doc_en.texi +++ /dev/null @@ -1,2914 +0,0 @@ -\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) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@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.1.7-cvs - December, 16 2005 - -@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}@* -@* -Copyright @copyright{} 2005 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 -* Plugins:: WeeChat plugins -* 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 (with SSL, IPv6, proxy) -@item -many GUI: Curses, wxWidgets, 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, MacOS X, 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{apt-get install weechat-curses} -@item -Mandriva/Redhat (or any RPM compatible distribution)@* -To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm} -@item -Gentoo@* -To install: @kbd{emerge weechat} -@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, Plugins, Installation, Top -@chapter Usage - -@menu -* Run WeeChat:: -* Config file:: -* Key bindings:: -* WeeChat commands:: -* FIFO pipe:: -@end menu - -@node Run WeeChat, Config file, Usage, Usage -@section Run WeeChat - -@subsection Command line parameters - -@table @code -@item -a, --no-connect -Disable auto-connect to servers at startup@* -@item -c, --config -Display config file help (list of options)@* -@item -f, --key-functions -Display WeeChat internal functions for keys@* -@item -h, --help -Display help screen@* -@item -i, --irc-commands -Display IRC commands list@* -@item -k, --keys -Display WeeChat default keys@* -@item -l, --license -Display WeeChat license@* -@item -p, --no-plugin -Don't load any plugin at startup -@item -v, --version -Display WeeChat version@* -@item -w, --weechat-commands -Display WeeChat commands list@* -@end table - -@subsection Run WeeChat - -Just issue this command to run WeeChat:@* -@kbd{weechat-curses} (for Curses front-end)@* -or @kbd{weechat-wxwidgets} (for wxWidgets front-end)@* -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 Config file, Key bindings, Run WeeChat, Usage -@section Config file - -List of options for config file:@* - -@table @kbd -@item look_set_title -Set title for window (terminal for Curses GUI) with name & version@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_logo -Display WeeChat logo at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_version -Display WeeChat version at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_weechat_slogan -WeeChat slogan (if empty, slogan is not used)@* -Type: string (any string), default value: 'the geekest IRC client!'@* -@item look_charset_decode_iso -ISO charset for decoding messages from server (used only if locale is UTF-8) (if empty, messages are not converted if locale is UTF-8@* -Type: string (any string), default value: 'ISO-8859-1'@* -@item look_charset_decode_utf -UTF charset for decoding messages from server (used only if locale is not UTF-8) (if empty, messages are not converted if locale is not UTF-8@* -Type: string (any string), default value: 'UTF-8'@* -@item look_charset_encode -Charset for encoding messages sent to server, examples: UFT-8, ISO-8859-1 (if empty, messages are not converted)@* -Type: string (any string), default value: ''@* -@item look_charset_internal -Forces internal WeeChat charset (should be empty in most cases, that means detected charset is used)@* -Type: string (any string), default value: ''@* -@item look_one_server_buffer -Use same buffer for all servers@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item look_buffer_timestamp -Timestamp for buffers@* -Type: string (any string), default value: '[%H:%M:%S]'@* -@item look_color_nicks_number -Number of colors to use for nicks colors@* -Type: integer (values: between 1 and 10), default value: 10@* -@item look_color_actions -Display actions with different colors@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist -Display nicklist window (for channel windows)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist_position -Nicklist position (top, left, right (default), bottom)@* -Type: string (values: 'left', 'right', 'top', 'bottom'), default value: 'right'@* -@item look_nicklist_min_size -Min size for nicklist (width or height, depending on look_nicklist_position (0 = no min size))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_nicklist_max_size -Max size for nicklist (width or height, depending on look_nicklist_position (0 = no max size; if min == max and > 0, then size is fixed))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_no_nickname -Text to display instead of nick when not connected@* -Type: string (any string), default value: '-cmd-'@* -@item look_nickmode -Display nick mode ((half)op/voice) before each nick@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nickmode_empty -Display space if nick mode is not (half)op/voice@* -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_nick_completion_ignore -Chars ignored for nick completion@* -Type: string (any string), default value: '[]-^'@* -@item look_infobar -Enable info bar@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_timestamp -Timestamp for time in infobar@* -Type: string (any string), default value: '%B, %A %d %Y'@* -@item look_infobar_seconds -Display seconds in infobar time@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_delay_highlight -Delay (in seconds) for highlight messages in infobar (0 = disable highlight notifications in infobar)@* -Type: integer (values: between 0 and 2147483647), default value: 7@* -@item look_hotlist_names_count -Max number of names in hotlist (0 = no name displayed, only buffer numbers)@* -Type: integer (values: between 0 and 32), default value: 3@* -@item look_hotlist_names_level -Level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)@* -Type: integer (values: between 1 and 15), default value: 12@* -@item look_hotlist_names_length -Max length of names in hotlist (0 = no limit)@* -Type: integer (values: between 0 and 32), default value: 0@* -@item look_day_change -Display special message when day changes@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_day_change_timestamp -Timestamp for date displayed when day changed@* -Type: string (any string), default value: '%a, %d %b %Y'@* -@item look_read_marker -Use a marker on servers/channels to show first unread line@* -Type: string (any string), default value: ' '@* -@item col_real_white -If set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item col_title -Color for title bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_title_bg -Background for title bar@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_chat -Color for chat text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time -Color for time in chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time_sep -Color for time separator (chat window)@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_prefix1 -Color for 1st and 3rd char of prefix@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_prefix2 -Color for middle char of prefix@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_server -Color for server name@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_join -Color for join arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_chat_part -Color for part/quit arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_chat_nick -Color for nicks in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_host -Color for hostnames (chat window)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_chat_channel -Color for channel names in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_dark -Color for dark separators (chat window)@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_chat_highlight -Color for highlighted nick (chat window)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_bg -Background for chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_read_marker -Color for unread data marker@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_read_marker_bg -Background for unread data marker@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_status -Color for status bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_delimiters -Color for status bar delimiters@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_status_channel -Color for current channel in status bar@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_data_msg -Color for window with new messages (status bar)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_status_private -Color for window with private message (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_status_highlight -Color for window with highlight (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_status_data_other -Color for window with new data (not messages) (status bar)@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_more -Color for window with new data (status bar)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_bg -Background for status window@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar -Color for info bar text@* -Type: color (Curses or Gtk color), default value: 'black'@* -@item col_infobar_delimiters -Color for infobar delimiters@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar_highlight -Color for info bar highlight notification@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_infobar_bg -Background for info bar window@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input -Color for input text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_input_channel -Color for input text (channel name)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_input_nick -Color for input text (nick name)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_input_delimiters -Color for input text (delimiters)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input_bg -Background for input window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick -Color for nicknames@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_away -Color for away nicknames@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_chanowner -Color for chan owner symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_chanadmin -Color for chan admin symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_op -Color for operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_halfop -Color for half-operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_voice -Color for voice symbol@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_nick_more -Color for '+' when scrolling nicks@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_sep -Color for nick separator@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_self -Color for local nick@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_nick_color1 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_color2 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_nick_color3 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_nick_color4 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_nick_color5 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightblue'@* -@item col_nick_color6 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_color7 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_nick_color8 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_color9 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_color10 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_private -Color for other nick in private window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@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: 'lightcyan'@* -@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 history_display_default -Maximum number of commands to display by default in history listing (0 = unlimited)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item log_auto_server -Automatically log server messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_channel -Automatically log channel chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_private -Automatically log private chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_plugin_msg -Log messages from plugins (scripts)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_path -Path for WeeChat log files@* -Type: string (any string), default value: '~/.weechat/logs/'@* -@item log_timestamp -Timestamp for log (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Hide password displayed by nickserv@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_display_away -Display message to all channels when (un)marking as away@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_default_msg_away -Default message when away@* -Type: string (any string), default value: 'away'@* -@item irc_default_msg_part -Default part message (leaving channel)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_default_msg_quit -Default quit message ('%v' will be replaced by WeeChat version in string)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_notice_as_pv -Display notices as private messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_away_check -Interval between two checks for away (in minutes, 0 = never check)@* -Type: integer (values: between 0 and 2147483647), default value: 0@* -@item irc_lag_check -Interval between two checks for lag (in seconds)@* -Type: integer (values: between 30 and 2147483647), default value: 60@* -@item irc_lag_min_show -Minimum lag to show (in seconds)@* -Type: integer (values: between 0 and 2147483647), default value: 1@* -@item irc_lag_disconnect -Disconnect after important lag (in minutes, 0 = never disconnect)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item irc_fifo_pipe -Create a FIFO pipe for remote control@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_highlight -Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)@* -Type: string (any string), default value: ''@* -@item irc_colors_receive -When off, colors codes are ignored in incoming messages@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_colors_send -Allow user to send colors with special codes (%B=bold, %Cxx,yy=color, %U=underline, %R=reverse)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_accept_files -Automatically accept incoming dcc files@* -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: 'off'@* -@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: 65536)@* -Type: integer (values: between 1024 and 102400), default value: 65536@* -@item dcc_port_range -Restricts outgoing dcc to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port)@* -Type: string (any string), default value: ''@* -@item dcc_own_ip -IP or DNS address used for outgoing dcc (if empty, local interface IP is used)@* -Type: string (any string), default value: ''@* -@item dcc_download_path -Path for writing incoming files with dcc (default: user home)@* -Type: string (any string), default value: '~'@* -@item dcc_upload_path -Path for reading files when sending thru dcc (when no path is specified)@* -Type: string (any string), default value: '~'@* -@item dcc_convert_spaces -Convert spaces to underscores when sending files@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_rename -Rename incoming files if already exists (add '.1', '.2', ...)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_resume -Automatically resume dcc transfer if connection with remote host is loosed@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item proxy_use -Use a proxy server to connect to irc server@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_type -Proxy type (http (default), socks4, socks5)@* -Type: string (values: 'http', 'socks4', 'socks5'), default value: 'http'@* -@item proxy_ipv6 -Connect to proxy in ipv6@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_address -Proxy server address (IP or hostname)@* -Type: string (any string), default value: ''@* -@item proxy_port -Port for connecting to proxy server@* -Type: integer (values: between 0 and 65535), default value: 3128@* -@item proxy_username -Username for proxy server@* -Type: string (any string), default value: ''@* -@item proxy_password -Password for proxy server@* -Type: string (any string), default value: ''@* -@item plugins_path -Path for searching plugins@* -Type: string (any string), default value: '~/.weechat/plugins'@* -@item plugins_autoload -Comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "libperl.so")@* -Type: string (any string), default value: '*'@* -@item plugins_extension -Standard plugins extension in filename, used for autoload (if empty, then all files are loaded when autoload is "*")@* -Type: string (any string), default value: '.so'@* -@item server_name -Name associated to IRC server (for display only)@* -Type: string (any string), default value: ''@* -@item server_autoconnect -Automatically connect to server when WeeChat is starting@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect -Automatically reconnect to server when disconnected@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect_delay -Delay (in seconds) before trying again to reconnect to server@* -Type: integer (values: between 0 and 65535), default value: 30@* -@item server_address -IP address or hostname of IRC server@* -Type: string (any string), default value: ''@* -@item server_port -Port for connecting to server@* -Type: integer (values: between 0 and 65535), default value: 6667@* -@item server_ipv6 -Use IPv6 protocol for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_ssl -Use SSL for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_password -Password for IRC server@* -Type: string (any string), default value: ''@* -@item server_nick1 -Nickname to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_nick2 -Alternate nickname to use on IRC server (if nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_nick3 -2nd alternate nickname to use on IRC server (if alternate nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_username -User name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_realname -Real name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_command -First command to run when connected to server@* -Type: string (any string), default value: ''@* -@item server_command_delay -Delay (in seconds) after command was executed (example: give some time for authentication)@* -Type: integer (values: between 0 and 5), default value: 0@* -@item server_autojoin -Comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")@* -Type: string (any string), default value: ''@* -@item server_autorejoin -Automatically rejoin channels when kicked@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_notify_levels -Comma separated list of notify levels for channels of this server (format: #channel:1,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_iso -Comma separated list of charsets for server and channels, to decode ISO (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_utf -Comma separated list of charsets for server and channels, to decode UTF (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_encode -Comma separated list of charsets for server and channels, to encode messages (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@end table - -Colors for Curses GUI are:@* -@itemize @minus -@item -@kbd{default}: default color (transparent for background) -@item -@kbd{black}: black -@item -@kbd{red}: dark red -@item -@kbd{lightred}: light red -@item -@kbd{green}: dark green -@item -@kbd{lightgreen}: light green -@item -@kbd{brown}: brown -@item -@kbd{yellow}: yellow -@item -@kbd{blue}: dark blue -@item -@kbd{lightblue}: light blue -@item -@kbd{magenta}: dark magenta -@item -@kbd{lightmagenta}: light magenta -@item -@kbd{cyan}: dark cyan -@item -@kbd{lightcyan}: light cyan -@item -@kbd{white}: white -@end itemize - -@node Key bindings, WeeChat commands, Config file, 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 / Ctrl + A -Go to the beginning of command line@* -@* -@item End / Ctrl + E -Go to the end of command line@* -@* -@item Ctrl + K -Delete until end of line@* -@* -@item Ctrl + L -Redraw whole window@* -@* -@item Ctrl + U -Delete until beginning of line@* -@* -@item Ctrl + W -Erase previous word of command line@* -@* -@item Backspace / Delete -Erase previous / next char 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 Ctrl + up arrow / Ctrl + down arrow -Call again last commands/messages in global history@* -@* -@item PageUp / PageDown -Show buffer history@* -@*
-@item F5 / F6 -Switch to previous / next buffer@* -@* -@item F7 / F8 -Switch to previous / next window@* -@* -@item F10 -Remove last infobar message@* -@* -@item F11 / F12 -Scroll nicklist@* -@* -@item Alt + left arrow / Alt + right arrow -Same as F5 / F6@* -@* -@item Alt + A -Switch to next buffer with activity (with priority: highlight, message, other)@* -@* -@item Alt + B -Go to previous word@* -@* -@item Alt + D -Delete next word@* -@* -@item Alt + F -Go to next word@* -@* -@item Alt + H -Clear hotlist (activity notification on other buffers)@* -@* -@item Alt + J then Alt + D -Display current DCC@* -@* -@item Alt + J then Alt + L -Switch to last buffer@* -@* -@item Alt + J then Alt + S -Switch to server buffer@* -@* -@item Alt + J then Alt + X -Switch to first channel of next server (or server buffer if no channel is opened)@* -@* -@item Alt + digit (1-9) -Switch to buffer by number@* -@* -@item Alt + J then number (01-99) -Switch to buffer by number@* -@* -@item Alt + K -Grab a key -@* -@item Alt + N -Scroll to next highlight@* -@* -@item Alt + P -Scroll to previous highlight@* -@* -@item Alt + R -Delete entire line@* -@* -@item Alt + S -Switch server on servers buffer@* -(if option ``look_one_server_buffer'' is enabled)@* -@* -@item Alt + U -Scroll to first unread line in buffer@* -@* -@item Alt + W then Alt + arrow -Switch to window with direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Scroll nicklist@* -@* -@end table - -@node WeeChat commands, FIFO pipe, Key bindings, Usage -@section WeeChat commands - -WeeChat internal commands:@* - -@table @kbd -@item alias [alias_name [command [arguments]] -@* -create an alias for a command@* -@* -alias_name: name of alias@* -command: command name (WeeChat or IRC command, without first '/')@* -arguments: arguments for command@* -@* -@item buffer [action | number | [[server] [channel]]] -@* -manage buffers@* -@* -action: action to do:@* - move: move buffer in the list (may be relative, for example -1)@* - close: close buffer (for channel: same as /part without part message)@* - list: list opened buffers (no parameter implies this list)@* - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)@* -server,channel: jump to buffer by server and/or channel name@* -number: jump to buffer by number@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -change charset for server or channel@* -@* -decode_iso: charset used for decoding ISO@* -decode_utf: charset used for decoding UTF@* - encode: charset used for encoding messages@* - charset: charset to use (for example: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -clear window(s)@* -@* --all: clear all windows@* -@* -@item connect [servername] -@* -connect to a server@* -@* -servername: server name to connect@* -@* -@item disconnect [servername] -@* -disconnect from a server@* -@* -servername: server name to disconnect@* -@* -@item debug dump | windows -@* -print debug messages@* -@* -dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)@* -windows: display windows tree@* -@* -@item help [command] -@* -display help about commands@* -@* -command: name of a WeeChat or IRC command@* -@* -@item history [clear | value] -@* -show buffer command history@* -@* -clear: clear history@* -value: number of history entries to show@* -@* -@item ignore [mask [[type | command] [channel [server]]]] -@* -ignore IRC messages and/or hosts@* -@* - mask: nick or host mask to ignore@* - type: type of message to ignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for ignore@* - server: name of server for ignore@* -@* -For each argument, '*' means all.@* -Without argument, /ignore command lists all defined ignore.@* -@* -@item key [key function/command] [unbind key] [functions] [reset -yes] -@* -bind/unbind keys@* -@* -key: bind this key to an internal function or a command (beginning by "/")@* -unbind: unbind a key (if "all", default bindings are restored)@* -functions: list internal functions for key bindings@* -reset: restore bindings to the default values and delete ALL personal binding (use carefully!)@* -@* -@item plugin [load filename] | [autoload] | [reload] | [unload] -@* -list/load/unload plugins@* -@* -filename: WeeChat plugin (file) to load@* -@* -Without argument, /plugin command lists all loaded plugins.@* -@* -@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] -@* -list, add or remove servers@* -@* -servername: server name, for internal & display use@* -hostname: name or IP address of server@* -port: port for server (integer)@* -ipv6: use IPv6 protocol@* -ssl: use SSL protocol@* -password: password for server@* -nick1: first nick for server@* -nick2: alternate nick for server@* -nick3: second alternate nick for server@* -username: user name@* -realname: real name of user@* -@* -@item save [file] -@* -save config to disk@* -@* -file: filename for writing config@* -@* -@item set [option [ = value]] -@* -set config parameters@* -@* -option: name of an option (if name is full and no value is given, then help is displayed on option)@* -value: value for option@* -@* -@item unalias alias_name -@* -remove an alias@* -@* -alias_name: name of alias to remove@* -@* -@item unignore [number | [mask [[type | command] [channel [server]]]]] -@* -unignore IRC messages and/or hosts@* -@* - number: # of ignore to unignore (number is displayed by list of ignore)@* - mask: nick or host mask to unignore@* - type: type of message to unignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for unignore@* - server: name of server for unignore@* -@* -For each argument, '*' means all.@* -Without argument, /unignore command lists all defined ignore.@* -@* -@item upgrade -@* -upgrade WeeChat without disconnecting from servers@* -@* -@item uptime [-o] -@* -show WeeChat uptime@* -@* --o: send uptime on current channel as an IRC message@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]] -@* -manage windows@* -@* -list: list opened windows (no parameter implies this list)@* --1: jump to previous window@* -+1: jump to next window@* -b#: jump to next window displaying buffer number #@* -up: switch to window above current one@* -down: switch to window below current one@* -left: switch to window on the left@* -right: switch to window on the right@* -splith: split current window horizontally@* -splitv: split current window vertically@* -resize: resize window size, new size is <pct>%% of parent window@* -merge: merge window with another (all = keep only one window)@* -@* -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4@* -@* -@end table - -IRC commands:@* - -@table @kbd -@item admin [target] -@* -find information about the administrator of the server@* -@* -target: server@* -@* -@item ame message -@* -send a CTCP action to all channels of all connected servers@* -@* -message: message to send@* -@* -@item amsg text -@* -send message to all channels of all connected servers@* -@* -text: text to send@* -@* -@item away [-all] [message] -@* -toggle away status@* -@* --all: toggle away status on all connected servers@* -message: message for away (if no message is given, away status is removed)@* -@* -@item ban [channel] [nickname [nickname ...]] -@* -bans nicks or hosts@* -@* -channel: channel for ban@* -nickname: user or host to ban@* -@* -@item ctcp nickname type [arguments] -@* -send a CTCP message (Client-To-Client Protocol)@* -@* -nickname: user to send CTCP to@* -type: CTCP type (examples: "version", "ping", ..)@* -arguments: arguments for CTCP@* -@* -@item dcc action [nickname [file]] -@* -starts DCC (file or chat) or close chat@* -@* -action: 'send' (file) or 'chat' or 'close' (chat)@* -nickname: nickname to send file or chat@* -file: filename (on local host)@* -@* -@item dehalfop [nickname [nickname]] -@* -removes half channel operator status from nickname(s)@* -@* -@item deop [nickname [nickname]] -@* -removes channel operator status from nickname(s)@* -@* -@item devoice [nickname [nickname]] -@* -removes voice from nickname(s)@* -@* -@item die -@* -shutdown the server@* -@* -@item halfop [nickname [nickname]] -@* -gives half channel operator status to nickname(s)@* -@* -@item info [target] -@* -get information describing the server@* -@* -target: server name@* -@* -@item invite nickname channel -@* -invite a nick on a channel@* -@* -nickname: nick to invite@* -channel: channel to invite@* -@* -@item ison nickname [nickname ...] -@* -check if a nickname is currently on IRC@* -@* -nickname: nickname@* -@* -@item join channel[,channel] [key[,key]] -@* -join a channel@* -@* -channel: channel name to join@* -key: key to join the channel@* -@* -@item kick [channel] nickname [comment] -@* -forcibly remove a user from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick@* -comment: comment for kick@* -@* -@item kickban [channel] nickname [comment] -@* -kicks and bans a nick from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick and ban@* -comment: comment for kick@* -@* -@item kill nickname comment -@* -close client-server connection@* -@* -nickname: nickname@* -comment: comment for kill@* -@* -@item links [[server] server_mask] -@* -list all servernames which are known by the server answering the query@* -@* -server: this server should answer the query@* -server_mask: list of servers must match this mask@* -@* -@item list [channel[,channel] [server]] -@* -list channels and their topic@* -@* -channel: channel to list@* -server: server name@* -@* -@item lusers [mask [target]] -@* -get statistics about the size of the IRC network@* -@* -mask: servers matching the mask only@* -target: server for forwarding request@* -@* -@item me message -@* -send a CTCP action to the current channel@* -@* -message: message to send@* -@* -@item mode @{ channel @{[+|-]|o|p|s|i|t|n|b|v@} [limit] [user] [ban mask] @} | @{ nickname @{[+|-]|i|w|s|o@} @} -@* -change channel or user mode@* -@* -channel modes:@* - channel: channel name to modify@* - o: give/take channel operator privileges@* - p: private channel flag@* - s: secret channel flag@* - i: invite-only channel flag@* - t: topic settable by channel operator only flag@* - n: no messages to channel from clients on the outside@* - m: moderated channel@* - l: set the user limit to channel@* - b: set a ban mask to keep users out@* - e: set exception mask@* - v: give/take the ability to speak on a moderated channel@* - k: set a channel key (password)@* -user modes:@* - nickname: nickname to modify@* - i: mark a user as invisible@* - s: mark a user for receive server notices@* - w: user receives wallops@* - o: operator flag@* -@* -@item motd [target] -@* -get the "Message Of The Day"@* -@* -target: server name@* -@* -@item msg receiver[,receiver] text -@* -send message to a nick or channel@* -@* -receiver: nick or channel (may be mask, '*' = current channel)@* -text: text to send@* -@* -@item names [channel[,channel]] -@* -list nicknames on channels@* -@* -channel: channel name@* -@* -@item nick [-all] nickname -@* -change current nickname@* -@* --all: set new nickname for all connected servers@* -nickname: new nickname@* -@* -@item notice nickname text -@* -send notice message to user@* -@* -nickname: user to send notice to@* -text: text to send@* -@* -@item op nickname [nickname] -@* -gives channel operator status to nickname(s)@* -@* -@item oper user password -@* -get operator privileges@* -@* -user/password: used to get privileges on current IRC server@* -@* -@item part [channel[,channel]] [part_message] -@* -leave a channel@* -@* -channel: channel name to leave@* -part_message: part message (displayed to other users)@* -@* -@item ping server1 [server2] -@* -ping server@* -@* -server1: server to ping@* -server2: forward ping to this server@* -@* -@item pong daemon [daemon2] -@* -answer to a ping message@* -@* -daemon: daemon who has responded to Ping message@* -daemon2: forward message to this daemon@* -@* -@item query nickname [text] -@* -send a private message to a nick@* -@* -nickname: nickname for private conversation@* -text: text to send@* -@* -@item quit [quit_message] -@* -close all connections & quit@* -@* -quit_message: quit message (displayed to other users)@* -@* -@item quote data -@* -send raw data to server without parsing@* -@* -data: raw data to send@* -@* -@item rehash -@* -tell the server to reload its config file@* -@* -@item restart -@* -tell the server to restart itself@* -@* -@item service nickname reserved distribution type reserved info -@* -register a new service@* -@* -distribution: visibility of service@* -type: reserved for future usage@* -@* -@item servlist [mask [type]] -@* -list services currently connected to the network@* -@* -mask: list only services matching this mask@* -type: list only services of this type@* -@* -@item squery service text -@* -deliver a message to a service@* -@* -service: name of service@* -text: text to send@* -@* -@item squit server comment -@* -disconnect server links@* -@* -server: server name@* -comment: comment for quit@* -@* -@item stats [query [server]] -@* -query statistics about server@* -@* -query: c/h/i/k/l/m/o/y/u (see RFC1459)@* -server: server name@* -@* -@item summon user [target [channel]] -@* -give users who are on a host running an IRC server a message asking them to please join IRC@* -@* -user: username@* -target: server name@* -channel: channel name@* -@* -@item time [target] -@* -query local time from server@* -@* -target: query time from specified server@* -@* -@item topic [channel] [topic] -@* -get/set channel topic@* -@* -channel: channel name@* -topic: new topic for channel (if topic is "-delete" then topic is deleted)@* -@* -@item trace [target] -@* -find the route to specific server@* -@* -target: server@* -@* -@item unban [channel] nickname [nickname ...] -@* -unbans nicks or hosts@* -@* -channel: channel for unban@* -nickname: user or host to unban@* -@* -@item userhost nickname [nickname ...] -@* -return a list of information about nicknames@* -@* -nickname: nickname@* -@* -@item users [target] -@* -list of users logged into the server@* -@* -target: server@* -@* -@item version [server | nickname] -@* -gives the version info of nick or server (current or specified)@* -@* -server: server name@* -nickname: nickname@* -@* -@item voice [nickname [nickname]] -@* -gives voice to nickname(s)@* -@* -@item wallops text -@* -send a message to all currently connected users who have set the 'w' user mode for themselves@* -@* -text to send@* -@* -@item who [mask ["o"]] -@* -generate a query which returns a list of information@* -@* -mask: only information which match this mask@* -o: only operators are returned according to the mask supplied@* -@* -@item whois [server] nickname[,nickname] -@* -query information about user(s)@* -@* -server: server name@* -nickname: nickname (may be a mask)@* -@* -@item whowas nickname [,nickname [,nickname ...]] [count [target]] -@* -ask for information about a nickname which no longer exists@* -@* -nickname: nickname to search@* -count: number of replies to return (full search if negative number)@* -target: reply should match this mask@* -@* -@end table - -Internal functions for keys:@* - -@table @kbd -@item return -terminate line@* -@item tab -complete word@* -@item backspace -delete previous char@* -@item delete -delete next char@* -@item delete_end_line -delete until end of line@* -@item delete_beginning_line -delete until beginning of line@* -@item delete_line -delete entire line@* -@item delete_previous_word -delete previous word@* -@item delete_next_word -delete next word@* -@item clipboard_paste -paste current clipboard content@* -@item transpose_chars -transpose chars@* -@item home -go to beginning of line@* -@item end -go to end of line@* -@item left -move one char left@* -@item previous_word -move to previous word@* -@item right -move one char right@* -@item next_word -move to next word@* -@item up -call previous command in history@* -@item up_global -call previous command in global history@* -@item down -call next command in history@* -@item down_global -call next command in global history@* -@item page_up -scroll one page up@* -@item page_down -scroll one page down@* -@item nick_beginning -display beginning of nicklist@* -@item nick_end -display end of nicklist@* -@item nick_page_up -scroll nicklist one page up@* -@item nick_page_down -scroll nicklist one page down@* -@item jump_smart -jump to buffer with activity@* -@item jump_dcc -jump to DCC buffer@* -@item jump_last_buffer -jump to last buffer@* -@item jump_server -jump to server buffer@* -@item jump_next_server -jump to next server@* -@item switch_server -switch active server on servers buffer@* -@item scroll_previous_highlight -scroll to previous highlight in buffer@* -@item scroll_next_highlight -scroll to next highlight in buffer@* -@item scroll_unread -scroll to first unread line in buffer@* -@item hotlist_clear -clear hotlist@* -@item infobar_clear -clear infobar@* -@item refresh -refresh screen@* -@item grab_key -grab a key@* -@end table - -@node FIFO pipe, , WeeChat commands, Usage -@section FIFO pipe - -You can remote control WeeChat, by sending commands or text to a FIFO pipe -(you have to enable option "irc_fifo_pipe", it is disabled by default).@* -The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" -(where xxxxx is the process ID (PID) of running WeeChat).@* -So if many WeeChat are running, you have many FIFO pipe, one for each session.@* -@* -The syntax for the FIFO pipe commands/text is:@* -@command{server,channel *text or command here}@* -where server and channel are optional, but if channel is here, server should be too.@* -@* -Some examples: -@table @asis -@item @bullet{} change your nick on freenode to "mynick|out": -@* -@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on #weechat channel: -@* -@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on current channel (buffer displayed by WeeChat): -@* -@command{echo "*hello!" >~/.weechat/weechat_fifo_12345} -@* -@b{Warning:} this is dangerous and you should not do that except if you know what you do! -@* -@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -You can write a script to send command to all running WeeChat at same time, for example:@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -If the script is called "auto_weechat_command", you can run it with:@* -@command{./auto_weechat_command "freenode,#weechat *hello"} - - -@c ******************************** Plugins *********************************** - -@node Plugins, Authors / Support, Usage, Top -@chapter Plugins - -@menu -* Plugins in WeeChat:: -* Write a plugin:: -* Plugin example:: -* Scripts plugins:: -@end menu - -@node Plugins in WeeChat, Write a plugin, Plugins, Plugins -@section Plugins in WeeChat - -A plugin is a C program which can call WeeChat functions defined in an -interface.@* -@* -This C program does not need WeeChat sources to compile and can be -dynamically loaded into WeeChat with command @command{/plugin}.@* -@* -The plugin has to be a dynamic library, for dynamic loading by -operating system. -Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under -Windows. - -@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins -@section Write a plugin - -@subsection Base rules - -The plugin should include ``weechat-plugin.h'' file (available in -WeeChat source code).@* -This file defines structures and types used to communicate with WeeChat.@* -@* -The plugin must have some variables and functions (mandatory, without -them the plugin can't load):@* -@itemize @bullet -@item variables for plugin description: -@itemize @minus -@item plugin_name[]: plugin name -@item plugin_version[]: plugin version -@item plugin_description[]: short description of plugin -@end itemize -@item functions for init and end of plugin: -@itemize @minus -@item weechat_plugin_init: function called when plugin is loaded, -must return PLUGIN_RC_OK if successful, PLUGIN_RC_KO if error -@item weechat_plugin_end: function called when plugin is unloaded -@end itemize -@end itemize - -@subsection API functions - -The plugin can call some functions defined in t_weechat_plugin -structure.@* -@* -These functions are detailed below:@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Locale and case independent string comparison.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Locale and case independent string comparison, for ``max'' chars.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@item @option{max}: max number of chars for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explode a string according to one or more delimiter(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string to explode -@item @option{separators}: delimiters used for explosion -@item @option{num_items_max}: maximum number of items created (0 means -no limit) -@item @option{num_items}: pointer to int which will contain number of -items created -@end itemize -@* -@emph{Return value:}@* -@* -Array of strings, NULL if problem.@* -Note: the result has to be free by a call to ``free_exploded_string'' -function after use.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Free memory used by a string explosion.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string exploded by ``explode_string'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Execute a function on all files of a directory.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{directory}: directory for searching files -@item @option{callback}: function called for each file found -@end itemize -@* -@emph{Return value:}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "file: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Display a message on a WeeChat buffer, identified by server and -channel (both may be NULL for current buffer).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server to find buffer for message -display (may be NULL) -@item @option{channel}: name of channel to find buffer for message -display (may be NULL) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Display a message on server buffer.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Display a message in infobar for a specified time.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{time}: time in seconds for displaying message (0 means -never erased) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Add an IRC message handler, called when an IRC message is received.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: IRC message (for example: ``PRIVMSG'') -@item @option{handler_func}: function called when message is received -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new message handler.@* -@* -@emph{Example:}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK received");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to -WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to -other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Add a WeeChat command handler, called when user uses command -(for example /command).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{command}: the new command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@item @option{handler_func}: function called when comand is executed -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new command handler.@* -@* -@emph{Example:}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "test command, -file: %s", (arguments) ? arguments : "none");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Test command", -"[file]", "file: a file name", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Remove a handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{handler}: handler to remove -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Remove all handlers for a plugin.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute a WeeChat command (or send a message to a channel).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server for executing command (may be -NULL) -@item @option{channel}: name of channel for executing command (may be -NULL) -@item @option{command}: command -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Return an info about WeeChat or a channel.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{info}: name of info to read: -@itemize @minus -@item @option{version}: get WeeChat's version -@item @option{nick}: get nick -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir -@end itemize -@item @option{server}: name of server for reading info (if needed) -@end itemize -@* -@emph{Return value:}@* -@* -Information asked, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Returns list of DCC currently active or finished.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -Chained list of DCC.@* -Note: result has to be free by a call to ``free_dcc_info'' function -after use.@* -@* -@emph{Example:}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, with: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Free memory used by a DCC list.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{dcc_info}: pointer to DCC list returned by -``get_dcc_info'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.option=value}@* -Note: plugin name is automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Example:}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "my_var");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.option=value}@* -Note: plugin name is automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_plugin_config (plugin, "my_var", "value");}@* -@* - -@end itemize - -@subsection Compile plugin - -Compile does not need WeeChat sources, only file -``weechat-plugin.h''.@* - -To compile a plugin which has one file ``toto.c'' (sous GNU/Linux):@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Load plugin under WeeChat - -Copy ``libtoto.so'' file into general plugins dir (for example -/usr/local/lib/weechat/plugins) or into user's plugins dir (for -example /home/xxxxx/.weechat/plugins).@* -@* -Under WeeChat:@* -@command{/plugin load toto} - -@node Plugin example, Scripts plugins, Write a plugin, Plugins -@section Plugin example - -Full example of plugin, which adds a /double command, which displays -two times arguments on current channel (ok that's not very useful, but -that's just an example!):@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/hello" command handler */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -@end verbatim - -@node Scripts plugins, , Plugin example, Plugins -@section Scripts plugins - -Three plugins are provided with WeeChat to use script languages: Perl, -Python and Ruby. - -@subsection Load/unload scripts - -Perl scripts are loaded and unloaded with @command{/perl}, -@command{/python} and @command{/ruby} commands. -(type @kbd{/help} within WeeChat to get help about commands).@* - -@emph{Examples:}@* -@itemize @bullet -@item -Load a Perl script: @kbd{/perl load /tmp/sample.pl}@* -@item -Unload all Perl scripts: @kbd{/perl unload}@* -@item -List all Perl scripts: @kbd{/perl}@* -@item -Load a Python script: @kbd{/python load /tmp/sample.py}@* -@item -Unload all Python scripts: @kbd{/python unload}@* -@item -List all Python scripts: @kbd{/python}@* -@end itemize - -@subsection WeeChat / Scripts API - -@itemize @bullet -@item -Perl: @command{weechat::register ( name, version, shutdown_function, -description );}@* -Python: @command{weechat.register ( name, version, shutdown_function, -description )}@* -@* -This is first function to call in script.@* -All 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}: 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{Return value:}@* -@* -1 if script was registered, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::register ("sample", "1.0", "sample_end", "Sample -script!");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.register ("sample", "1.0", "sample_end", "Sample -script!")}@* -@* - -@item -Perl: @command{weechat::print ( message, [channel, [server]] );}@* -Python: @command{weechat.prnt ( message, [channel, [server]] )}@* -@* -Print message in a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{message}: message to display -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( delay, message );}@* -Python: @command{weechat.print_infobar ( delay, message )}@* -@* -Print message in infobar.@* - -@emph{Arguments:} -@itemize @minus -@item @option{delay}: after this delay (in seconds), message will be erased -(if 0, message will not be erased). -@item @option{message}: message to display -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( name, function );}@* -Python: @command{weechat.add_message_handler ( name, function )}@* -@* -Attach a script 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}: function called when message is received -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_message_handler ("privmsg", my_function);}@* -@code{sub my_function}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("server=$_[0]\n");}@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* -@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_message_handler ("privmsg", my_function)}@* -@code{def my_function(server, args):}@* -@code{@ @ @ @ weechat.prnt("server="+server)}@* -@code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent -to WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent -to other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Create new WeeChat command, linked with script 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 -script function. Be careful when overriding WeeChat commands, they'll not be -available until your script will be unloaded. -@item @option{function}: function linked with command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_command_handler ("command", my_command);}@* -@code{sub my_command}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_command_handler ("command", my_command)}@* -@code{def my_command(server, args):}@* -@code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( name, function );}@* -Python: @command{weechat.remove_handler ( name, function )}@* -@* -Remove a message or command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of IRC message or command handler -@item @option{function}: function -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::remove_handler ("command", my_command);}@* -@* -@emph{Python example:}@* -@* -@code{weechat.remove_handler ("command", my_command)}@* -@* - -@item -Perl: @command{weechat::command ( command, [channel, [server]] );}@* -Python: @command{weechat.command ( command, [channel, [server]] )}@* -@* -Execute a command or send a message to a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{command}: command to execute (or message to send in a channel) -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::command ("hello world!");}@* -@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.command ("hello world!")}@* -@code{weechat.command ("/kick toto please leave this chan", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( name, [server] );}@* -Python: @command{weechat.get_info ( name, [server] )}@* -@* -Get various info about WeeChat, server or user.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of info to retrieve: -@itemize @minus -@item @option{version}: get WeeChat version -@item @option{nick}: get nickname -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir - -@end itemize -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -Asked info, empty if error occured or info was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$version = weechat::get_info("version");}@* -@code{$nick = weechat::get_info("nick", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{$version = weechat.get_info("version")}@* -@code{$nick = weechat.get_info("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( );}@* -@* -Get DCC list.@* - -Returned array has following fields: -@itemize @minus -@item server: IRC server -@item channel: IRC channel -@item type: DCC type: -@itemize @minus -@item 0: chat (received) -@item 1: chat (sent) -@item 2: file (receiving) -@item 3: file (sending) -@end itemize -@item status: DCC status: -@itemize @minus -@item 0: waiting -@item 1: connecting -@item 2: active -@item 3: done -@item 4: failed -@item 5: aborted -@end itemize -@item start_time: date/time of DCC creation -@item start_transfer: date/time of transfer start -@item addr: remote address -@item port: port used for DCC -@item nick: remote nick -@item filename: filename -@item local_filename: local filename -@item size: file size -@item pos: current position in file -@item start_resume: restart position after interruption -@item bytes_per_sec: bytes sent/received per second -@end itemize -@* -@emph{Return value:}@* -@* -DCC list, 0 if error occured.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Python examples:}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, value );}@* -Python: @command{weechat.set_config ( option, value )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin"", -"#weechat");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl example:}@* -@* -@code{$value = weechat::get_plugin_config ("my_var");}@* -@* -@emph{Python example:}@* -@* -@code{$value = weechat.get_plugin_config ("my_var")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, value );}@* -Python: @command{weechat.set_plugin_config ( option, value )}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::set_plugin_config ("my_var", "value");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.set_plugin_config ("my_var", "value")}@* -@* - -@end itemize - - -@c **************************** Authors / Support ***************************** - -@node Authors / Support, , Plugins, 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}> - -@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: @uref{http://forums.flashtux.org}@*@* -@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{} 2005 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_es.texi b/doc/weechat_doc_es.texi deleted file mode 100644 index 3f424d89f..000000000 --- a/doc/weechat_doc_es.texi +++ /dev/null @@ -1,2911 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename weechat_doc_es.info -@settitle WeeChat - Cliente IRC r@'apido, ligero y extensible -@c %**end of header - -@c WeeChat documentation (spanish version) -@c -@c Copyright (c) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@c pdf : texi2pdf weechat_doc_es.texi -@c html: makeinfo --html --no-split --number-sections weechat_doc_es.texi - -@c tex -@c \overfullrule=0pt -@c end tex - -@documentlanguage es -@documentencoding ISO-8859-1 - -@titlepage - -@title WeeChat - Gui@'on de usuario. -@subtitle Cliente IRC r@'apido, peque@~no y extensible -@subtitle Documentaci@'on para WeeChat v0.1.7-cvs - 16 de diciembre de 2005 - -@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> - -@page - -Este manual documenta el cliente de IRC WeeChat, y hace parte del proyecto.@* -@* -Puede obtener la @`ultima versi@'on de este documento en la p@'agina:@* -@uref{http://weechat.flashtux.org/doc.php}@* -@* -Copyright @copyright{} 2005 FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* -Traducido en espa@~nol por Iznogoud <@email{iznogoud@@dlfp.org, iznogoud AT dlfp.org}>@* -@* -Puede utilizar este documento seg@'un los t@'erminos de la licencia GNU General Public -License versi@'on 2 o posterior. - -@end titlepage - -@everyheading @thischapter @| @| -@everyfooting @thistitle @| @| Page @thispage - -@contents - -@node Top, Introduccion, (dir), (dir) -@menu -* Introduccion:: Presentaci@'on de WeeChat -* Instalacion:: Instalaci@'on de WeeChat -* Uso:: Utilizaci@'on de WeeChat -* Plugins:: WeeChat plugins -* Autores / Soporte:: Contactar los autores y obtener soporte -@end menu - - -@c ******************************* Introducci'on ******************************* - -@node Introduccion, Instalacion, Top, Top -@chapter Introducci@'on -@menu -* Descripcion:: -* Requisitos:: -@end menu - -@node Descripcion, Requisitos, Introduccion, Introduccion -@section Descripci@'on - -WeeChat (Wee Enhanced Environment for Chat) es un cliente de IRC libre, r@'apido y de peque@~no tama@~no, -dise@~nado para diferentes sistemas operativos.@* -@* -Las caracter@'isticas principales son las siguientes: -@itemize @minus -@item -conexi@'on multi-servidores (con SSL, IPv6, proxy) -@item -m@'ultiples interfaces: Curses, wxWidgets, Gtk y Qt -@item -peque@~no, r@'apido y ligero. -@item -parametrizable y extensible mediante guiones (scripts) -@item -conforme a las RFCs 1459, 2810, 2811, 2812, y 2813 -@item -multi-plataforma (Gnu/Linux, *BSD, MacOS X, Windows y otros sistemas operativos) -@item -100% GPL, con Licencia Libre -@end itemize - -@* -La p@'agina Web de WeeChat est@'a aqu@'i (en franc@'es):@* -@uref{http://weechat.flashtux.org}@* - -@node Requisitos, , Descripcion, Introduccion -@section Requisitos - -Los requisitos para instalar WeeChat son:@* - -@itemize @bullet -@item -Un sistema operativo GNU/Linux (con compilador y herramientas asociadas para paquetes de c@'odigo fuente) -@item -Acceso a la cuenta "root" (para instalar WeeChat) -@item -Seg@'un el interfaz, una de las bibliotecas siguientes: -@itemize @minus -@item -Curses: la librer@'ia ncurses, -@item -Gtk: *** interfaz no desarrollada por el momento ***, -@item -Qt: *** interfaz no desarrollada por el momento ***, -@end itemize -@end itemize - - -@c ******************************* Instalaci@'on ******************************* - -@node Instalacion, Uso, Introduccion, Top -@chapter Instalaci@'on - -@menu -* Paquetes binarios:: -* Paquetes de fuentes:: -* CVS:: -@end menu - -@node Paquetes binarios, Paquetes de fuentes, Instalacion, Instalacion -@section Paquetes binarios - -Los paquetes binarios est@'an disponibles para las siguientes distribuciones: -@itemize @bullet -@item -Debian (o compatible con Debian)@* -Para instalar WeeChat: @kbd{apt-get install weechat-curses} -@item -Mandrake/Redhat (o cualquier distribuci@'on compatible con los paquetes RPM)@* -Para instalar WeeChat: @kbd{rpm -i /direccion/weechat-x.y.z-1.i386.rpm} -@item -Gentoo@* -Para instalar WeeChat: @kbd{emerge -pf weechat && emerge weechat} -@item -BSD (no disponible !) -@item -Slackware (no disponible!) -@item -Windows (no disponible!) -@end itemize - -donde x.y.z es la versi@'on de WeeChat (por ejemplo 0.0.1) -@* - -@node Paquetes de fuentes, CVS, Paquetes binarios, Instalacion -@section Paquetes de fuentes - -Escribe en un terminal o una consola:@* -@kbd{./configure}@* -@kbd{make}@* -Nota: si quieres construir WeeChat @'unicamente para ciertas interfaces, puedes a@~nadir Par@'ametros a -./configure, escribe @kbd{./configure --help} para obtener ayuda sobre estas opciones.@* - -Adquiere los derechos de root e instala WeeChat:@* -@kbd{su}@* -(introduce la contrase@~na de root)@* -@kbd{make install}@* - -@node CVS, , Paquetes de fuentes, Instalacion -@section CVS - -Atenci@'on: Las fuentes CVS est@'an reservadas para usuarios con experiencia: Es posible que WeeChat no -se instale o que se sea bastante inestable. -@exclamdown{}Ya te he avisado!@* - -Para recuperar las fuentes CVS, escribe las l@'ineas siguientes:@* -@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* -@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* -(Si te pregunta una contrase@~na, simplemente pulsa la tecla Entrar)@* - -Ejecuta el script:@* -@kbd{./autogen.sh}@* - -Luego, lee las instructiones para Paquetes de fuentes - @xref{Paquetes de fuentes}. - - -@c ******************************* Utilisaci@'on ******************************** - -@node Uso, Plugins, Instalacion, Top -@chapter Uso - -@menu -* Iniciar WeeChat:: -* Ficheros de configuracion:: -* Atajos de teclado:: -* Comandos WeeChat:: -* Canal FIFO:: -@end menu - -@node Iniciar WeeChat, Ficheros de configuracion, Uso, Uso -@section Iniciar WeeChat - -@subsection Par@'ametros de l@'inea de comandos - -@table @code -@item -a, --no-connect -Disable auto-connect to servers at startup@* -@item -c, --config -Obtener la ayuda del fichero de configuraci@'on (lista de opciones)@* -@item -f, --key-functions -Display WeeChat internal functions for keys@* -@item -h, --help -Obtener la ayuda@* -@item -i, --irc-commands -Display IRC commands list@* -@item -k, --keys -Display WeeChat default keys@* -@item -l, --license -Obtener la licencia de WeeChat@* -@item -p, --no-plugin -Don't load any plugin at startup -@item -v, --version -Obtener la versi@'on de WeeChat@* -@item -w, --weechat-commands -Display WeeChat commands list@* -@end table - -@subsection Lanzar WeeChat - -Para ejecutar WeeChat, basta escribir la l@'inea siguiente:@* -@kbd{weechat-curses} (para el interfaz con Curses)@* -o @kbd{weechat-wxwidgets} (para el interfaz con wxWidgets)@* -o @kbd{weechat-gtk} (para el interfaz con Gtk)@* -o @kbd{weechat-qt} (para el interfaz con Qt)@* - -Cuando se ejecuta WeeChat por primera vez, un fichero de configuraci@'on se crea con las opciones por defecto;@* -El fichero de configuraci@'on por defecto est@'a en: ~/.weechat/weechat.rc@* - -Puedes editarlo para configurar WeeChat con las opciones deseadas, o tambi@'en puedes modificar los par@'ametros directamente en WeeChat, con la l@'inea @kbd{/set} - @xref{Comandos WeeChat}. - -@node Ficheros de configuracion, Atajos de teclado, Iniciar WeeChat, Uso -@section Ficheros de configuraci@'on - -Enumeraci@'on de las opciones del fichero de configuraci@'on:@* - -@table @kbd -@item look_set_title -Define el t@'itulo de la ventana (el terminal para la interfaz Curses) con el nombre y la versi@'on@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_startup_logo -Mostrar el logotipo de WeeChat en el arranque@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_startup_version -Mostrar la versi@'on de Weechat en el arranque@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_weechat_slogan -Esl@'ogan de WeeChat (si est@'a vac@'io, el esl@'ogan no ser@'a utilizado)@* -Typo: cadena (cualquier cadena), valor por defecto: 'the geekest IRC client!'@* -@item look_charset_decode_iso -Juego de caracteres ISO para decodificar mensajes del servidor (usado s@'olo si locale es UTF-8) (si est@'a vac@'io, los mensajes no se convierten si locale es UTF-8@* -Typo: cadena (cualquier cadena), valor por defecto: 'ISO-8859-1'@* -@item look_charset_decode_utf -Juego de caracteres UTF para decodificar mensajes del servidor (usado s@'olo si locale no es UTF-8) (si est@'a vac@'io, los mensajes no se convierten si locale no es UTF-8@* -Typo: cadena (cualquier cadena), valor por defecto: 'UTF-8'@* -@item look_charset_encode -Juego de caracteres para codificar los mensajes enviados al servidor, ejemplos: UTF-8, ISO-8859-1 (si est@'a vac@'io, los mensajes no se convierten)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item look_charset_internal -Fuerza el juego de caracteres interno de Weechat (deber@'ia estar vac@'io en la mayor@'ia de los casos, eso significa que se utiliza el juego de caracteres detectado)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item look_one_server_buffer -Usar el mismo búfer para todos los servidores@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item look_buffer_timestamp -Fecha y hora para las búfers@* -Typo: cadena (cualquier cadena), valor por defecto: '[%H:%M:%S]'@* -@item look_color_nicks_number -Número de colores para usar en los colores de nombres de usuario@* -Typo: entero (valores: entre 1 y 10), valor por defecto: 10@* -@item look_color_actions -Mostrar acciones con colores diferentes@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_nicklist -Mostrar ventana de usuarios (para las ventanas de canal)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_nicklist_position -Posici@'on de la ventana de usuarios (arriba (top), izquierda (left), derecha (right, por defecto), abajo (bottom))@* -Typo: cadena (valores: 'left', 'right', 'top', 'bottom'), valor por defecto: 'right'@* -@item look_nicklist_min_size -Tama@~no m@'inimo para la ventana de usuarios (ancho o alto, dependiendo de look_nicklist_position (0 = sin tama@~no m@'inimo))@* -Typo: entero (valores: entre 0 y 100), valor por defecto: 0@* -@item look_nicklist_max_size -Tama@~no m@'aximo para la ventana de usuarios (ancho o alto, dependiendo de look_nicklist_position (0 = sin tama@~no m@'aximo, si min == max y > 0, entonces se fija el tama@~no))@* -Typo: entero (valores: entre 0 y 100), valor por defecto: 0@* -@item look_no_nickname -Texto a mostrar en lugar del nick cuando no se est@'a conectado@* -Typo: cadena (cualquier cadena), valor por defecto: '-cmd-'@* -@item look_nickmode -Mostrar modo del usuario ((half)op/voice) antes de cada usuario@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_nickmode_empty -Mostrar un espacio si el modo de usuario no es (half)op/voice@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item look_nick_completor -La cadena mostrada tras la finalizaci@'on de los nombres de usuario@* -Typo: cadena (cualquier cadena), valor por defecto: ':'@* -@item look_nick_completion_ignore -Caracteres ignorados para el completado del nombre de usuario@* -Typo: cadena (cualquier cadena), valor por defecto: '[]-^'@* -@item look_infobar -Activa la barra de informaci@'on@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_infobar_timestamp -Fecha y hora para las conversaciones guardadas@* -Typo: cadena (cualquier cadena), valor por defecto: '%B, %A %d %Y'@* -@item look_infobar_seconds -Mostrar segundos en la hora de la barra de herramientas@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_infobar_delay_highlight -Retraso (en segundos) para la notificaci@'on de mensajes en la barra de informaci@'on (0 = desactivar las notificaciones en la barra de informaci@'on)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 7@* -@item look_hotlist_names_count -Número m@'aximo de nombres en la hotlist (0 = no se muestra ninguno, s@'olo los números de búfer)@* -Typo: entero (valores: entre 0 y 32), valor por defecto: 3@* -@item look_hotlist_names_level -Nivel para mostrar mensajes en la hotlist (combinaci@'on de: 1=join/part, 2=mensaje, 4=privado, 8=resaltado, por ejemplo: 12=privado + resaltado)@* -Typo: entero (valores: entre 1 y 15), valor por defecto: 12@* -@item look_hotlist_names_length -Longitud m@'axima de nombres en la hotlist (0 = sin l@'imite)@* -Typo: entero (valores: entre 0 y 32), valor por defecto: 0@* -@item look_day_change -Mostrar un mensaje especial cuando el d@'ia cambia@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_day_change_timestamp -Marca de tiempo para la fecha mostrada cuando el d@'ia cambi@'o@* -Typo: cadena (cualquier cadena), valor por defecto: '%a, %d %b %Y'@* -@item look_read_marker -Use a marker on servers/channels to show first unread line@* -Typo: cadena (cualquier cadena), valor por defecto: ' '@* -@item col_real_white -Si se establece, usa el color blanco verdadero, desactivado por defecto para terminales con el fondo blanco (si tu nunca usas un fondo blanco, deber@'ias activar esta opci@'on para ver el blanco verdadero en vez del color de primer plano del terminal por defecto)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item col_title -Color para la barra de t@'itulo@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_title_bg -Color de fondo para la barra de t@'itulo@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_chat -Color para el texto de conversaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_time -Color para la hora en la ventana de conversaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_time_sep -Color para el separador de la hora (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'brown'@* -@item col_chat_prefix1 -Color para el primer o tercer car@'acter de prefijo@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_chat_prefix2 -Color para el car @'acter de en medio del prefijo@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_chat_server -Color para el nombre del servidor@* -Typo: color (color Curses o Gtk), valor por defecto: 'brown'@* -@item col_chat_join -Color para la flecha de join (prefijo)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_chat_part -Color para la flecha de part/quit (prefijo)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item col_chat_nick -Color para los nombres de usuario en las acciones (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_chat_host -Color para los nombres de m@'aquina (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_chat_channel -Color para los nombres de canal en las acciones (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_chat_dark -Color para los separadores oscuros (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'green'@* -@item col_chat_highlight -Color para el alias subrayado (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_chat_bg -Color de fondo para la ventana de conversaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_read_marker -Color for unread data marker@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_chat_read_marker_bg -Background for unread data marker@* -Typo: color (color Curses o Gtk), valor por defecto: 'magenta'@* -@item col_status -Color para la barra de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_status_delimiters -Color para los delimitadores de la barra de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_status_channel -Color para el canal actual en la barra de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_status_data_msg -Color para una ventana con mensajes nuevos (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_status_private -Color para una ventana con un mensaje privado (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_status_highlight -Color para una ventana con resaltado (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item col_status_data_other -Color para una ventana con nuevos datos (no mensajes) (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_status_more -Color para una ventana con nuevos datos (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_status_bg -Color de fondo para la ventana de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_infobar -Color para el texto de la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'black'@* -@item col_infobar_delimiters -Color para los delimitadores de la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_infobar_highlight -Color para la notificaci@'on en la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_infobar_bg -Color de fondo para la ventana de la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_input -Color para el texto de entrada@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_input_channel -Color para el texto de entrada (nombre de canal)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_input_nick -Color para el texto de entrada (alias)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_input_delimiters -Color para el texto de entrada (delimitadores)@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_input_bg -Color de fondo para la ventana de entrada@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick -Color para los nombres de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick_away -Color para los usuarios ausentes@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_nick_chanowner -Color para el s@'imbolo de propietario de canal (especificado en unrealircd)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_chanadmin -Color para el s@'imbolo de administrador de canal (especificado en unrealircd)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_op -Color para el s@'imbolo de operador@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_halfop -Color para el s@'imbolo de semi-operador@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_nick_voice -Color para el s@'imbolo de voz@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_nick_more -Color para '+' al desplazar nicks@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_nick_sep -Color para el separador de alias@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_nick_self -Color para el alias local@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_nick_color1 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_nick_color2 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'magenta'@* -@item col_nick_color3 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'green'@* -@item col_nick_color4 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'brown'@* -@item col_nick_color5 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightblue'@* -@item col_nick_color6 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick_color7 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_nick_color8 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_nick_color9 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_color10 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_nick_private -Color para el otro alias en la ventana privada@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick_bg -Color de fondo para los nombres de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_dcc_selected -Color para el DCC seleccionado (ventana de conversaci@'in)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_dcc_waiting -Color para el estado dcc "esperando"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_dcc_connecting -Color para el estado dcc "conectando"@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_dcc_active -Color para el estado dcc "activo"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightblue'@* -@item col_dcc_done -Color para el estado dcc "terminado"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_dcc_failed -Color para el estado dcc "fallo"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item col_dcc_aborted -Color para el estado dcc "abortado"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item history_max_lines -Número m@'aximo de l@'ineas en el hist@'orico para un servidor/canal/privado (0 = ilimitado)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 4096@* -@item history_max_commands -Número múximo de comandos de usuario en el hist@'orico (0 = ilimitado)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 100@* -@item history_display_default -Número m@'aximo de comandos para mostrar por defecto en el listado del historial (0 = ilimitado)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 5@* -@item log_auto_server -Registrar autom@'aticamente los mensajes de servidor@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_auto_channel -Registrar autom@'aticamente las conversaciones de canal@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_auto_private -Registrar autom@'aticamente las conversaciones privadas@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_plugin_msg -Registrar mensajes de plugins (scripts)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_path -Ruta para los archivos de registro (logs) de WeeChat@* -Typo: cadena (cualquier cadena), valor por defecto: '~/.weechat/logs/'@* -@item log_timestamp -Fecha y hora para los registros (ver man strftime para el formato de fecha/hora)@* -Typo: cadena (cualquier cadena), valor por defecto: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Ocultar contrase@~na mostrada por nickserv@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item irc_display_away -Mostrar mensaje en todos los canales cuando se vuelva del estado ausente@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item irc_default_msg_away -Mensaje por defecto para el estado ausente@* -Typo: cadena (cualquier cadena), valor por defecto: 'away'@* -@item irc_default_msg_part -Mensaje por defecto de salida (saliendo de un canal)@* -Typo: cadena (cualquier cadena), valor por defecto: 'WeeChat %v'@* -@item irc_default_msg_quit -Mensaje de fin por defecto ('%v' ser@'a reemplazado por la versi@'on de WeeChat en la cadena)@* -Typo: cadena (cualquier cadena), valor por defecto: 'WeeChat %v'@* -@item irc_notice_as_pv -Mostrar noticias como mensajes privados@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item irc_away_check -Intervalo entre dos comprobaciones de ausencia (en minutos, 0 = no comprobar)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 0@* -@item irc_lag_check -Intervalo entre dos medidas de lag (en segundos)@* -Typo: entero (valores: entre 30 y 2147483647), valor por defecto: 60@* -@item irc_lag_min_show -Lag m@'inimo a mostrar (en segundos)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 1@* -@item irc_lag_disconnect -Desconexi@'on tras un lag importante (en minutos, 0 = no desconectar nunca)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 5@* -@item irc_fifo_pipe -Crea una tuber@'ia FIFO para control remoto@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item irc_highlight -Lista separada por comas de palabras a resaltar (comparaci@'on insensible a mayúsculas, las palabras pueden empezar o terminar con "*" para una concordancia parcial)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item irc_colors_receive -Cuando se desactiva, los c@'odigos de color se ignoran en los mensajes entrantes@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item irc_colors_send -Permitir al usuario enviar colores con c@'odigos especiales (%B=negrita, %Cxx,yy=color, %U=subrayado, %R=invertido) @* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item dcc_auto_accept_files -Aceptar autom@'aticamente los ficheros dcc entrantes@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item dcc_auto_accept_chats -Aceptar autom@'aticamente las peticiones de conversaci@'on dcc (¡utilizar con precauci@'on!)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item dcc_timeout -Tiempo de espera para la petici@'on dcc (en segundos)@* -Typo: entero (valores: entre 1 y 2147483647), valor por defecto: 300@* -@item dcc_blocksize -Tama@~no de bloque para los paquetes dcc en bytes (por defecto: 65536)@* -Typo: entero (valores: entre 1024 y 102400), valor por defecto: 65536@* -@item dcc_port_range -Restringe el dcc de salida a utilizar únicamente los puertos del rango especificado (útil para NAT) (sintaxis: un puerto simple, e.g. 5000, o un rango de puertos, e.g. 5000-5015, un valor vac@'io significa cualquier puerto)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item dcc_own_ip -Direcci@'on IP o DNS usado para dcc de salida (si est@'a vac@'io, se utiliza la IP de interfaz local)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item dcc_download_path -Ruta para los ficheros recibidos con dcc (por defecto: directorio home del usuario)@* -Typo: cadena (cualquier cadena), valor por defecto: '~'@* -@item dcc_upload_path -Ruta para la lectura de ficheros cuando se env@'ian a trav@'es de dcc (cuando no se especifica una ruta)@* -Typo: cadena (cualquier cadena), valor por defecto: '~'@* -@item dcc_convert_spaces -Convertir los espacios a subrayados cuando se env@'ian los ficheros@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item dcc_auto_rename -Renombrar los ficheros recibidos si ya existen (a@~nadir '.1', '.2', ...)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item dcc_auto_resume -Continuar autom@'aticamente la transferencia dcc si se ha perdido la conexi@'on con la m@'aquina remota@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item proxy_use -Utilizar un proxy para conectarse al servidor irc@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item proxy_type -Tipo de proxy(http (por defecto), socks4, socks5)@* -Typo: cadena (valores: 'http', 'socks4', 'socks5'), valor por defecto: 'http'@* -@item proxy_ipv6 -Conectar al proxy en ipv6@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item proxy_address -Direcci@'on del servidor proxy (IP o nombre de m@'aquina)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item proxy_port -Puerto para conectarse al servidor proxy@* -Typo: entero (valores: entre 0 y 65535), valor por defecto: 3128@* -@item proxy_username -Nombre de usuario para el servidor proxy@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item proxy_password -Contrase@~na para el servidor proxy@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item plugins_path -Ruta para la búsqueda de plugins@* -Typo: cadena (cualquier cadena), valor por defecto: '~/.weechat/plugins'@* -@item plugins_autoload -Lista de plugins separados por comas para cargar autom@'aticamente al iniciar, "*" significa todos los plugins encontrados (los nombres pueden ser parciales, por ejemplo "perl" est@'a bien para "libperl.so")@* -Typo: cadena (cualquier cadena), valor por defecto: '*'@* -@item plugins_extension -Extensi@'on de plugins est@'andar en nombre de archivo, usada para la autocarga (si est@'a vac@'io, entonces se cargan todos los archivos cuando la autocarga es "*")@* -Typo: cadena (cualquier cadena), valor por defecto: '.so'@* -@item server_name -Nombre asociado al servidor IRC (para mostrar solamente)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_autoconnect -Conexi@'on autom@'atica al servidor cuando WeeChat est@'a arrancando@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item server_autoreconnect -Reconexi@'on autom@'atica al servidor tras una desconexi@'on@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item server_autoreconnect_delay -Espera (en segundos) antes de intentar de nuevo una reconexi@'on al servidor@* -Typo: entero (valores: entre 0 y 65535), valor por defecto: 30@* -@item server_address -Direcci@'on IP o nombre de m@'aquina del servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_port -Puerto para conectarse al servidor@* -Typo: entero (valores: entre 0 y 65535), valor por defecto: 6667@* -@item server_ipv6 -Usar el protocolo IPv6 para la comunicaci@'on del servidor@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item server_ssl -Usar SSL para la comunicaci@'on del servidor@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item server_password -Contrase@~na para el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_nick1 -Nombre de usuario a utilizar en el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_nick2 -Nombre de usuario alternativo para el servidor IRC (si el nombre de usuario ya est@'a en uso)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_nick3 -Segundo nombre de usuario alternativo a utilizar en el servidor IRC (si el nombre de usuario alternativo ya est@'a en uso)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_username -Nombre de usuario para el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_realname -Nombre real para el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_command -Primer comando a ejecutar cuando se conecte a un servidor@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_command_delay -Espera (en segundos) despu@'es de que el comando sea ejecutado (ejemplo: dar algo de tiempo para la autenticaci@'on)@* -Typo: entero (valores: entre 0 y 5), valor por defecto: 0@* -@item server_autojoin -Lista de canales (separados por comas) a unirse cuando se conecte a un servidor (ejemplo: "#chan1,#chan2,#chan3 key1,key2")@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_autorejoin -Unirse de nuevo autom@'aticamente a los canales cuando sea expulsado@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item server_notify_levels -Lista separada por comas de niveles de notificaci@'on para canales de este servidor (formato: #canal:1,...)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_charset_decode_iso -Comma separated list of charsets for server and channels, to decode ISO (format: server:charset,#channel:charset,..)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_charset_decode_utf -Comma separated list of charsets for server and channels, to decode UTF (format: server:charset,#channel:charset,..)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_charset_encode -Comma separated list of charsets for server and channels, to encode messages (format: server:charset,#channel:charset,..)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@end table - -Los colores para el interfaz Curses son:@* -@itemize @minus -@item -@kbd{default}: color por defecto (con transparencia para el fondo) -@item -@kbd{black}: negro -@item -@kbd{red}: rojo oscuro -@item -@kbd{lightred}: rojo claro -@item -@kbd{green}: verde oscuro -@item -@kbd{lightgreen}: verde claro -@item -@kbd{brown}: marr@'on -@item -@kbd{yellow}: amarillo -@item -@kbd{blue}: azul oscuro -@item -@kbd{lightblue}: azul claro -@item -@kbd{magenta}: violeta oscuro -@item -@kbd{lightmagenta}: violeta claro -@item -@kbd{cyan}: cyan oscuro -@item -@kbd{lightcyan}: cyan claro -@item -@kbd{white}: blanco -@end itemize - -@node Atajos de teclado, Comandos WeeChat, Ficheros de configuracion, Uso -@section Atajos de teclado - -@table @kbd -@item Flecha izquierda / Flecha derecha -Ir a la letra anterior / siguiente en la l@'inea de comandos@* -@* -@item Ctrl + flecha izquierda / Ctrl + flecha derecha -Ir a la palabra anterior / siguiente en la l@'inea de comandos@* -@* -@item Inicio / Ctrl + A -Ir al inicio de la l@'inea de comandos@* -@* -@item Fin / Ctrl + E -Ir al final de la l@'inea de comandos@* -@* -@item Ctrl + K -Delete until end of line@* -@* -@item Ctrl + L -Refrescar toda la ventana@* -@* -@item Ctrl + U -Delete until beginning of line@* -@* -@item Ctrl + W -Borrar la palabra anterior en la l@'inea de comandos@* -@* -@item Backspace / Supr -Borrar el caracter anterior / siguiente en la l@'inea de comandos@* -@* -@item Tab -Completar el comando o el seud@'onimo (@kbd{Tab} de nuevo: encontrar la pr@'oxima autocompletaci@'on)@* -@* -@item Cualquier caracter -A@~nadir la letra en la posici@'on del cursor en la l@'inea de comandos@* -@* -@item Entrar -Ejecutar la l@'inea de comandos o enviar el mensaje@* -@* -@item Flecha de arriba / Flecha de abajo -Mostrar los @'ultimos comandos/mensajes@* -@* -@item Ctrl + up arrow / Ctrl + down arrow -Call again last commands/messages in global history@* -@* -@item PageUp / PageDown -Obtener el hist@'orico de la memoria temporal (buffer)@* -@* -@item F5 / F6 -Ir a la memoria temporal anterior / siguiente@* -@* -@item F7 / F8 -Ir a la ventana anterior / siguiente@* -@* -@item F10 -Borrar el @'ultimo mensaje en la barra de informaciones@* -@* -@item F11 / F12 -Scroll nicklist@* -@* -@item Alt + flecha izquierda / Alt + flecha derecha -Como F5 / F6@* -@* -@item Alt + A -Ir a la memoria temporal donde hay actividad (con el orden de prioridad siguiente: resaltado, mensaje, otros)@* -@* -@item Alt + B -Go to previous word@* -@* -@item Alt + D -Delete next word@* -@* -@item Alt + F -Go to next word@* -@* -@item Alt + H -Borrar la 'hotlist' (notificaci@'on de actividad en otras memorias temporales)@* -@* -@item Alt + J then Alt + D -Obtener la lista de DCC actual@* -@* -@item Alt + J then Alt + L -Switch to last buffer@* -@* -@item Alt + J then Alt + S -Ir a la memoria temporal del servidor@* -@* -@item Alt + J then Alt + X -Ir al primer canal del servidor siguiente (o a la memoria temporal del servidor si ning@'un canal est@'a abierto)@* -@* -@item Alt + (1-9) -Saltar a la memoria temporal con ese n@'umero@* -@* -@item Alt + J then number (01-99) -Saltar a la memoria temporal con ese n@'umero@* -@* -@item Alt + K -Grab a key -@* -@item Alt + N -Scroll to next highlight@* -@* -@item Alt + P -Scroll to previous highlight@* -@* -@item Alt + R -Delete entire line@* -@* -@item Alt + S -Switch server on servers buffer@* -(if option ``look_one_server_buffer'' is enabled)@* -@* -@item Alt + U -Scroll to first unread line in buffer@* -@* -@item Alt + W then Alt + arrow -Switch to window with direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Scroll nicklist@* -@* -@end table - -@node Comandos WeeChat, Canal FIFO, Atajos de teclado, Uso -@section Comandos WeeChat - -Comandos internos WeeChat:@* - -@table @kbd -@item alias [alias_name [command [arguments]] -@* -create an alias for a command@* -@* -alias_name: name of alias@* -command: command name (WeeChat or IRC command, without first '/')@* -arguments: arguments for command@* -@* -@item buffer [action | number | [[server] [channel]]] -@* -manage buffers@* -@* -action: action to do:@* - move: move buffer in the list (may be relative, for example -1)@* - close: close buffer (for channel: same as /part without part message)@* - list: list opened buffers (no parameter implies this list)@* - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)@* -server,channel: jump to buffer by server and/or channel name@* -number: jump to buffer by number@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -change charset for server or channel@* -@* -decode_iso: charset used for decoding ISO@* -decode_utf: charset used for decoding UTF@* - encode: charset used for encoding messages@* - charset: charset to use (for example: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -clear window(s)@* -@* --all: clear all windows@* -@* -@item connect [servername] -@* -connect to a server@* -@* -servername: server name to connect@* -@* -@item disconnect [servername] -@* -disconnect from a server@* -@* -servername: server name to disconnect@* -@* -@item debug dump | windows -@* -print debug messages@* -@* -dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)@* -windows: display windows tree@* -@* -@item help [command] -@* -display help about commands@* -@* -command: name of a WeeChat or IRC command@* -@* -@item history [clear | value] -@* -show buffer command history@* -@* -clear: clear history@* -value: number of history entries to show@* -@* -@item ignore [mask [[type | command] [channel [server]]]] -@* -ignore IRC messages and/or hosts@* -@* - mask: nick or host mask to ignore@* - type: type of message to ignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for ignore@* - server: name of server for ignore@* -@* -For each argument, '*' means all.@* -Without argument, /ignore command lists all defined ignore.@* -@* -@item key [key function/command] [unbind key] [functions] [reset -yes] -@* -bind/unbind keys@* -@* -key: bind this key to an internal function or a command (beginning by "/")@* -unbind: unbind a key (if "all", default bindings are restored)@* -functions: list internal functions for key bindings@* -reset: restore bindings to the default values and delete ALL personal binding (use carefully!)@* -@* -@item plugin [load filename] | [autoload] | [reload] | [unload] -@* -list/load/unload plugins@* -@* -filename: WeeChat plugin (file) to load@* -@* -Without argument, /plugin command lists all loaded plugins.@* -@* -@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] -@* -list, add or remove servers@* -@* -servername: server name, for internal & display use@* -hostname: name or IP address of server@* -port: port for server (integer)@* -ipv6: use IPv6 protocol@* -ssl: use SSL protocol@* -password: password for server@* -nick1: first nick for server@* -nick2: alternate nick for server@* -nick3: second alternate nick for server@* -username: user name@* -realname: real name of user@* -@* -@item save [file] -@* -save config to disk@* -@* -file: filename for writing config@* -@* -@item set [option [ = value]] -@* -set config parameters@* -@* -option: name of an option (if name is full and no value is given, then help is displayed on option)@* -value: value for option@* -@* -@item unalias alias_name -@* -remove an alias@* -@* -alias_name: name of alias to remove@* -@* -@item unignore [number | [mask [[type | command] [channel [server]]]]] -@* -unignore IRC messages and/or hosts@* -@* - number: # of ignore to unignore (number is displayed by list of ignore)@* - mask: nick or host mask to unignore@* - type: type of message to unignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for unignore@* - server: name of server for unignore@* -@* -For each argument, '*' means all.@* -Without argument, /unignore command lists all defined ignore.@* -@* -@item upgrade -@* -upgrade WeeChat without disconnecting from servers@* -@* -@item uptime [-o] -@* -show WeeChat uptime@* -@* --o: send uptime on current channel as an IRC message@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]] -@* -manage windows@* -@* -list: list opened windows (no parameter implies this list)@* --1: jump to previous window@* -+1: jump to next window@* -b#: jump to next window displaying buffer number #@* -up: switch to window above current one@* -down: switch to window below current one@* -left: switch to window on the left@* -right: switch to window on the right@* -splith: split current window horizontally@* -splitv: split current window vertically@* -resize: resize window size, new size is <pct>%% of parent window@* -merge: merge window with another (all = keep only one window)@* -@* -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4@* -@* -@end table - -Comandos IRC:@* - -@table @kbd -@item admin [target] -@* -encontrar informaci@'on sobre el administrador del servidor@* -@* -target: servidor objetivo@* -@* -@item ame mensaje -@* -send a CTCP action to all channels of all connected servers@* -@* -mensaje: mensaje a enviar@* -@* -@item amsg texto -@* -send message to all channels of all connected servers@* -@* -texto: texto a enviar@* -@* -@item away [-all] [mensaje] -@* -revertir el estado ausente@* -@* --all: revertir el estado ausente en todos los servidores conectados@* -mensaje: mensaje para el estado ausente (si no se da ningún mensaje, se elimina el estado ausente)@* -@* -@item ban [canal] [usariio [usuario ...]] -@* -banea usuarios o m@'aquinas@* -@* -canal: canal en el que banear@* -usuario: nombre de usuario o m@'aquina a banear@* -@* -@item ctcp nickname type [arguments] -@* -send a CTCP message (Client-To-Client Protocol)@* -@* -nickname: user to send CTCP to@* -type: CTCP type (examples: "version", "ping", ..)@* -arguments: arguments for CTCP@* -@* -@item dcc acci@'on [usuario [fichero]] -@* -empieza DCC (archivo @'o charla) @'o cerrar charla@* -@* -acci@'on: 'send' (env@'io de archivo) @'o 'chat' (charla) @'o 'close' (cerrar charla)@* -usuario: nombre de usuario a quien enviar el archivo o la charla@* -fichero: nombre del fichero (en la m@'aquina local)@* -@* -@item dehalfop [pseudo [pseudo]] -@* -elimina el estado de media operador de canal a/a los usuario(s)@* -@* -@item deop [pseudo [pseudo]] -@* -elimina el estado de operador de canal a/a los usuario(s)@* -@* -@item devoice [pseudo [pseudo]] -@* -elimina la voz a/a los usuario(s)@* -@* -@item die -@* -cerrar el servidor@* -@* -@item halfop [pseudo [pseudo]] -@* -dar el estado de media operador de canal a/a los usuario(s)@* -@* -@item info [target] -@* -obtener informaci@'on describiendo al servidor@* -@* -objetivo: nombre del servidor@* -@* -@item invite usuario canal -@* -invitar a un usuario a un canal@* -@* -nickname: usuario a invitar@* -channel: canal para la invitaci@'on@* -@* -@item ison usuario [usuario ...] -@* -comprobar si un usuario est@'a actualmente en el IRC@* -@* -usuario: usuario@* -@* -@item join canal[,canal] [clave[,clave]] -@* -unirse a un canal@* -@* -canal: nombre del canal al que unirse@* -clave: clave para unirse al canal@* -@* -@item kick [canal] usuario [comentario] -@* -expulsar forzosamente a un usuario de un canal@* -@* -canal: canal en el que est@'a el usuario@* -usuario: usuario a expulsar@* -comentario: comentario para la expulsi@'on@* -@* -@item kickban [canal] usuario [comentario] -@* -expulsa y banea a un usuario de un canal@* -@* -canal: canal donde est@'a el usuario@* -usuario: nombre de usuario a expulsar y banear@* -comentario: comentario para la expulsi@'on@* -@* -@item kill usuario comentario -@* -cerrar la conexi@'on cliente-servidor@* -@* -usuario: usuario@* -comentario: comentario para la muerte@* -@* -@item links [[servidor] m@'ascara_servidor] -@* -listar todos los nombres de servidor conocidos por el servidor que responde a la consulta@* -@* -servidor: este servidor deber@'ia responder a la consulta@* -m@'ascara_servidor: listado de servidores que deben coincidir con esta m@'ascara@* -@* -@item list [canal[,canal] [servidor]] -@* -listar canales y sus temas@* -@* -canal: canal a listar@* -servidor: nombre del servidor@* -@* -@item lusers [m@'ascara [objetivo]] -@* -obtener estad@'isticas sobre el tama@~no de la red IRC@* -@* -m@'ascara: servidores que coinciden s@'olo con la m@'ascara@* -objetivo: servidor al que remitir la consulta@* -@* -@item me mensaje -@* -enviar una acci@'on CTCP al canal actual@* -@* -mensaje: mensaje a enviar@* -@* -@item mode @{ canal @{[+|-]|o|p|s|i|t|n|b|v@} [limitar] [usuario] [m@'ascara de baneo] @} | @{ usuario @{[+|-]|i|w|s|o@} @} -@* -cambiar modo del canal o del usuario@* -@* -channel modes:@* - channel: channel name to modify@* - o: give/take channel operator privileges@* - p: private channel flag@* - s: secret channel flag@* - i: invite-only channel flag@* - t: topic settable by channel operator only flag@* - n: no messages to channel from clients on the outside@* - m: moderated channel@* - l: set the user limit to channel@* - b: set a ban mask to keep users out@* - e: set exception mask@* - v: give/take the ability to speak on a moderated channel@* - k: set a channel key (password)@* -user modes:@* - nickname: nickname to modify@* - i: mark a user as invisible@* - s: mark a user for receive server notices@* - w: user receives wallops@* - o: operator flag@* -@* -@item motd [target] -@* -obtener el mensaje del d@'ia@* -@* -objetivo: nombre del servidor@* -@* -@item msg destinatario[,destinatario] texto -@* -enviar un mensaje a un usuario o canal@* -@* -destinatario: usuario o canal (puede que sea una m@'ascara, '*' = canal actual)@* -texto: texto a enviar@* -@* -@item names [canal[,canal]] -@* -listar usuarios en canales@* -@* -canal: nombre del canal@* -@* -@item nick [-all] usuarios -@* -cambiar el nombre de usuario actual@* -@* --all: establece el nuevo nombre de usuario para todos los servidores conectados@* -nickname: nuevo nombre de usuario@* -@* -@item notice usuario texto -@* -enviar mensaje de aviso a usuario@* -@* -usuario: usuario destinatario del aviso@* -texto: texto a enviar@* -@* -@item op pseudo [pseudo] -@* -dar el estado de operador de canal a/a los usuario(s)@* -@* -@item oper contrase@~na de usuario -@* -obtener el estado de operador@* -@* -usuario/contrase@~na: usado para obtener los privilegios en el servidor IRC actual@* -@* -@item part [canal[,canal]] [mensaje_de_salida] -@* -abandonar un canal@* -@* -canal: canal a abandonar@* -mensaje de salida: mensaje de partida (mostrado al resto de usuarios)@* -@* -@item ping servidor1 [servidor2] -@* -hacer ping a un servidor@* -@* -servidor1: servidor al que hacer ping@* -servidor2: remitir el ping a este servidor@* -@* -@item pong demonio [demonio2] -@* -contestar a un mensaje de ping@* -@* -demonio: demonio que ha contestado al mensaje Ping@* -d@'emon2: remitir el mensaje a este demonio@* -@* -@item query usuario [texto] -@* -enviar un mensaje privado a un usuario@* -@* -usuario: usuario para conversaci@'on privada@* -texto: texto a enviar@* -@* -@item quit [mensaje_de_salida] -@* -cerrar todas las conexiones y salir@* -@* -mensaje_de_salida: mensaje de partida (mostrado al resto de usuarios)@* -@* -@item quote datos -@* -enviar datos en sucio al servidor sin analizar@* -@* -datos: datos en sucio a enviar@* -@* -@item rehash -@* -pedir al servidor que recarque su archivo de configuraci@'on@* -@* -@item restart -@* -pedir al servidor que se reinicie@* -@* -@item service usuario reservado distribuci@'on tipo reservado info -@* -registrar un nuevo servicio@* -@* -distribuci@'on: visibilidad del servicio@* -tipo: reservado para una futura utilizaci@'on@* -@* -@item servlist [m@'ascara [tipo]] -@* -listar servicios conectados actualmente a la red@* -@* -m@'ascara: listar s@'olo aquellos servicios que concuerdan con esta m@'ascara@* -tipo: listar s@'olo servicios de este tipo@* -@* -@item squery servicio texto -@* -enviar un mensaje a un servicio@* -@* -servicio: nombre del servicio@* -texto: texto a enviar@* -@* -@item squit comentario de servidor -@* -desconectar los enlaces de servidor@* -@* -servidor: nombre del servidor@* -comentario: comentario para salir@* -@* -@item stats [consulta [servidor]] -@* -pedir estad@'isticas sobre el servidor@* -@* -consulta: c/h/i/k/l/m/o/y/u (ver la RFC1459)@* -servidor: nombre del servidor@* -@* -@item summon usuario [destinatario [canal]] -@* -enviar a los usuarios que est@'an en una m@'aquina local ejecutando un servidor IRC un mensaje pidi@'endoles que se unan al IRC@* -@* -usuario: nombre de usuario@* -destinatario: nombre del servidor@* -canal: nombre del canal@* -@* -@item time [target] -@* -pedir la hora local del servidor@* -@* -destinatario: pedir la hora de ese servidor@* -@* -@item topic [canal] [tema] -@* -obtener/establecer el tema de un canal@* -@* -canal: nombre del canal@* -tema: nuevo tema para el canal (si el tema es "-delete" entonces se elimina el tema actual)@* -@* -@item trace [target] -@* -encontrar la ruta hacia el servidor especificado@* -@* -target: servidor objetivo@* -@* -@item unban [canal] usuario [usuario ...] -@* -desbanea usuarios o m@'aquinas@* -@* -canal: canal en el que desbanear (quitar la prohibici@'on)@* -usuario: usuario o m@'aquina a desbanear@* -@* -@item userhost usuario [usuario ...] -@* -devuelve una lista de informaci@'on sobre usuarios@* -@* -usuario: usuario@* -@* -@item users [target] -@* -lista de usuarios conectados al servidor@* -@* -target: servidor objetivo@* -@* -@item version [servidor | usuario] -@* -da la informaci@'on de versi@'on del usuario o servidor (actual o especificado)@* -@* -servidor: nombre de servidor@* -usuario: usuario@* -@* -@item voice [pseudo [pseudo]] -@* -da voz a/a los usuario(s)@* -@* -@item wallops texto -@* -enviar un mensaje a todos los usuarios conectados que tengan activo el modo de usuario w para ellos mismos@* -@* -texto a enviar@* -@* -@item who [m@'ascara ["o"]] -@* -genera una consulta que devuelve una lista de informaci@'on@* -@* -m@'ascara: s@'olo informaci@'on que concuerde con esta m@'ascara@* -o: s@'olo son devueltos operadores de acuerdo con la m@'ascara proporcionada@* -@* -@item whois [servidor] usuario[,usuario] -@* -pedir informaci@'on sobre el/los usuario(s)@* -@* -servidor: nombre del servidor@* -usuario: nombre de usuario (puede que sea una m@'ascara)@* -@* -@item whowas usuario [,usuario [,usuario ...]] [número [destinatario]] -@* -pedir informaci@'on sobre un usuario que ya no existe@* -@* -usuario: nombre de usuario a buscar@* -número: número de respuestas a devolver (búsqueda completa si el número es negativo)@* -destinatario: la respuesta deber@'ia concordar con esta m@'ascara@* -@* -@end table - -Internal functions for keys:@* - -@table @kbd -@item return -terminate line@* -@item tab -complete word@* -@item backspace -delete previous char@* -@item delete -delete next char@* -@item delete_end_line -delete until end of line@* -@item delete_beginning_line -delete until beginning of line@* -@item delete_line -delete entire line@* -@item delete_previous_word -delete previous word@* -@item delete_next_word -delete next word@* -@item clipboard_paste -paste current clipboard content@* -@item transpose_chars -transpose chars@* -@item home -go to beginning of line@* -@item end -go to end of line@* -@item left -move one char left@* -@item previous_word -move to previous word@* -@item right -move one char right@* -@item next_word -move to next word@* -@item up -call previous command in history@* -@item up_global -call previous command in global history@* -@item down -call next command in history@* -@item down_global -call next command in global history@* -@item page_up -scroll one page up@* -@item page_down -scroll one page down@* -@item nick_beginning -display beginning of nicklist@* -@item nick_end -display end of nicklist@* -@item nick_page_up -scroll nicklist one page up@* -@item nick_page_down -scroll nicklist one page down@* -@item jump_smart -jump to buffer with activity@* -@item jump_dcc -jump to DCC buffer@* -@item jump_last_buffer -jump to last buffer@* -@item jump_server -jump to server buffer@* -@item jump_next_server -jump to next server@* -@item switch_server -switch active server on servers buffer@* -@item scroll_previous_highlight -scroll to previous highlight in buffer@* -@item scroll_next_highlight -scroll to next highlight in buffer@* -@item scroll_unread -scroll to first unread line in buffer@* -@item hotlist_clear -clear hotlist@* -@item infobar_clear -clear infobar@* -@item refresh -refresh screen@* -@item grab_key -grab a key@* -@end table - -@node Canal FIFO, , Comandos WeeChat, Uso -@section Canal FIFO - -Puedes controlar WeeChat a distantia, enviando comandos o texto a un canal FIFO -(debes activar la opci@'on "irc_fifo_pipe" que est@'a desactivada por defecto).@* -El canal FIFO est@'a dentro del directorio ~/.weechat/ y se llama -"weechat_fifo_xxxxx" (donde xxxxx es el ID del proceso (PID) de WeeChat).@* -Entonces si tienes varios WeeChat que se est@'an ejecutando, tendr@'as varios -canales FIFO, uno por cada sesi@'on.@* -@* -La sintaxis para enviar comandos o texto dentro del canal FIFO es la siguiente:@* -@command{servidor,canal *texto o comando aqu@'i}@* -donde el serviros y el canal son opcionales pero si precisa el canal, debes -precisar tambi@'en el servidor.@* -@* -Algunos ejemplos: -@table @asis -@item @bullet{} cambiar el seud@'onimo en freenode por "mynick|out": -@* -@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} escribir texto en el canal #weechat: -@* -@command{echo "freenode,#weechat *@exclamdown{}Hola a todos!" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} escribir texto en el canal corriente (el que se puede visualizar en WeeChat actualmente) -@* -@command{echo "*@exclamdown{}Hola!" >~/.weechat/weechat_fifo_12345} -@* -@b{Advertencia:} esto es peligroso y no deber@'ias hacerlo.. salvo si lo que est@'as haciendo. -@* -@item @bullet{} enviar dos comandos para descargar y recargar los scripts Perl (tienes que separarlos con un \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -Puedes escribir un script que envia los comandos a todos los programas WeeChat -que se est@'an ejecutando de momento. Por ejemplo:@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -Si el script se llama "auto_weechat_command", puedes ejecutarlo hac@'i:@* -@command{./auto_weechat_command "freenode,#weechat *Hola"} - - -@c ******************************** Plugins *********************************** - -@node Plugins, Autores / Soporte, Uso, Top -@chapter Plugins - -@menu -* Plugins in WeeChat:: -* Write a plugin:: -* Plugin example:: -* Scripts plugins:: -@end menu - -@node Plugins in WeeChat, Write a plugin, Plugins, Plugins -@section Plugins in WeeChat - -A plugin is a C program which can call WeeChat functions defined in an -interface.@* -@* -This C program does not need WeeChat sources to compile and can be -dynamically loaded into WeeChat with command @command{/plugin}.@* -@* -The plugin has to be a dynamic library, for dynamic loading by -operating system. -Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under -Windows. - -@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins -@section Write a plugin - -@subsection Base rules - -The plugin should include ``weechat-plugin.h'' file (available in -WeeChat source code).@* -This file defines structures and types used to communicate with WeeChat.@* -@* -The plugin must have some variables and functions (mandatory, without -them the plugin can't load):@* -@itemize @bullet -@item variables for plugin description: -@itemize @minus -@item plugin_name[]: plugin name -@item plugin_version[]: plugin version -@item plugin_description[]: short description of plugin -@end itemize -@item functions for init and end of plugin: -@itemize @minus -@item weechat_plugin_init: function called when plugin is loaded, -must return PLUGIN_RC_OK (0) if successful, PLUGIN_RC_KO (-1) if error -@item weechat_plugin_end: function called when plugin is unloaded -@end itemize -@end itemize - -@subsection API functions - -The plugin can call some functions defined in t_weechat_plugin -structure.@* -@* -These functions are detailed below:@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Locale and case independent string comparison.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Locale and case independent string comparison, for ``max'' chars.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@item @option{max}: max number of chars for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explode a string according to one or more delimiter(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string to explode -@item @option{separators}: delimiters used for explosion -@item @option{num_items_max}: maximum number of items created (0 means -no limit) -@item @option{num_items}: pointer to int which will contain number of -items created -@end itemize -@* -@emph{Return value:}@* -@* -Array of strings, NULL if problem.@* -Note: the result has to be free by a call to ``free_exploded_string'' -function after use.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Free memory used by a string explosion.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string exploded by ``explode_string'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Execute a function on all files of a directory.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{directory}: directory for searching files -@item @option{callback}: function called for each file found -@end itemize -@* -@emph{Return value:}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "file: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Display a message on a WeeChat buffer, identified by server and -channel (both may be NULL for current buffer).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server to find buffer for message -display (may be NULL) -@item @option{channel}: name of channel to find buffer for message -display (may be NULL) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Display a message on server buffer.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Display a message in infobar for a specified time.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{time}: time in seconds for displaying message (0 means -never erased) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Add an IRC message handler, called when an IRC message is received.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: IRC message (for example: ``PRIVMSG'') -@item @option{handler_func}: function called when message is received -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new message handler.@* -@* -@emph{Example:}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK received");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to -WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to -other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Add a WeeChat command handler, called when user uses command -(for example /command).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{command}: the new command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@item @option{handler_func}: function called when comand is executed -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new command handler.@* -@* -@emph{Example:}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "test command, -file: %s", (arguments) ? arguments : "none");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Test command", -"[file]", "file: a file name", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Remove a handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{handler}: handler to remove -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Remove all handlers for a plugin.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute a WeeChat command (or send a message to a channel).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server for executing command (may be -NULL) -@item @option{channel}: name of channel for executing command (may be -NULL) -@item @option{command}: command -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Return an info about WeeChat or a channel.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{info}: name of info to read: -@itemize @minus -@item @option{version}: get WeeChat's version -@item @option{nick}: get nick -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir -@end itemize -@item @option{server}: name of server for reading info (if needed) -@end itemize -@* -@emph{Return value:}@* -@* -Information asked, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Returns list of DCC currently active or finished.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -Chained list of DCC.@* -Note: result has to be free by a call to ``free_dcc_info'' function -after use.@* -@* -@emph{Example:}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, with: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Free memory used by a DCC list.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{dcc_info}: pointer to DCC list returned by -``get_dcc_info'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Example:}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "my_var");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_plugin_config (plugin, "my_var", "value");}@* -@* - -@end itemize - -@subsection Compile plugin - -Compile does not need WeeChat sources, only file -``weechat-plugin.h''.@* - -To compile a plugin which has one file ``toto.c'' (sous GNU/Linux):@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Load plugin under WeeChat - -Copy ``libtoto.so'' file into general plugins dir (for example -/usr/local/lib/weechat/plugins) or into user's plugins dir (for -example /home/xxxxx/.weechat/plugins).@* -@* -Under WeeChat:@* -@command{/plugin load toto} - -@node Plugin example, Scripts plugins, Write a plugin, Plugins -@section Plugin example - -Full example of plugin, which adds a /double command, which displays -two times arguments on current channel (ok that's not very useful, but -that's just an example!):@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/hello" command handler */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -@end verbatim - -@node Scripts plugins, , Plugin example, Plugins -@section Scripts plugins - -Three plugins are provided with WeeChat to load scripts: Perl, -Python and Ruby. - -@subsection Load/unload scripts - -Perl scripts are loaded and unloaded with @command{/perl}, -@command{/python} and @command{/ruby} commands. -(type @kbd{/help} within WeeChat to get help about commands).@* - -@emph{Examples:}@* -@itemize @bullet -@item -Load a Perl script: @kbd{/perl load /tmp/sample.pl}@* -@item -Unload all Perl scripts: @kbd{/perl unload}@* -@item -List all Perl scripts: @kbd{/perl}@* -@item -Load a Python script: @kbd{/python load /tmp/sample.py}@* -@item -Unload all Python scripts: @kbd{/python unload}@* -@item -List all Python scripts: @kbd{/python}@* -@end itemize - -@subsection WeeChat / Scripts API - -@itemize @bullet -@item -Perl: @command{weechat::register ( name, version, shutdown_function, -description );}@* -Python: @command{weechat.register ( name, version, shutdown_function, -description )}@* -@* -This is first function to call in script.@* -All 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}: 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{Return value:}@* -@* -1 if script was registered, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::register ("sample", "1.0", "sample_end", "Sample -script!");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.register ("sample", "1.0", "sample_end", "Sample -script!")}@* -@* - -@item -Perl: @command{weechat::print ( message, [channel, [server]] );}@* -Python: @command{weechat.prnt ( message, [channel, [server]] )}@* -@* -Print message in a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{message}: message to display -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( delay, message );}@* -Python: @command{weechat.print_infobar ( delay, message )}@* -@* -Print message in infobar.@* - -@emph{Arguments:} -@itemize @minus -@item @option{delay}: after this delay (in seconds), message will be erased -(if 0, message will not be erased). -@item @option{message}: message to display -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( name, function );}@* -Python: @command{weechat.add_message_handler ( name, function )}@* -@* -Attach a script 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}: function called when message is received -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_message_handler ("privmsg", my_function);}@* -@code{sub my_function}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("server=$_[0]\n");}@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* -@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_message_handler ("privmsg", my_function)}@* -@code{def my_function(server, args):}@* -@code{@ @ @ @ weechat.prnt("server="+server)}@* -@code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent -to WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent -to other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Create new WeeChat command, linked with script 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 -script function. Be careful when overriding WeeChat commands, they'll not be -available until your script will be unloaded. -@item @option{function}: function linked with command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_command_handler ("command", my_command);}@* -@code{sub my_command}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_command_handler ("command", my_command)}@* -@code{def my_command(server, args):}@* -@code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( name, function );}@* -Python: @command{weechat.remove_handler ( name, function )}@* -@* -Remove a message or command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of IRC message or command handler -@item @option{function}: function -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::remove_handler ("command", my_command);}@* -@* -@emph{Python example:}@* -@* -@code{weechat.remove_handler ("command", my_command)}@* -@* - -@item -Perl: @command{weechat::command ( command, [channel, [server]] );}@* -Python: @command{weechat.command ( command, [channel, [server]] )}@* -@* -Execute a command or send a message to a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{command}: command to execute (or message to send in a channel) -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::command ("hello world!");}@* -@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.command ("hello world!")}@* -@code{weechat.command ("/kick toto please leave this chan", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( name, [server] );}@* -Python: @command{weechat.get_info ( name, [server] )}@* -@* -Get various info about WeeChat, server or user.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of info to retrieve: -@itemize @minus -@item @option{version}: get WeeChat version -@item @option{nick}: get nickname -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir - -@end itemize -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -Asked info, empty if error occured or info was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$version = weechat::get_info("version");}@* -@code{$nick = weechat::get_info("nick", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{$version = weechat.get_info("version")}@* -@code{$nick = weechat.get_info("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( );}@* -@* -Get DCC list.@* - -Returned array has following fields: -@itemize @minus -@item server: IRC server -@item channel: IRC channel -@item type: DCC type: -@itemize @minus -@item 0: chat (received) -@item 1: chat (sent) -@item 2: file (receiving) -@item 3: file (sending) -@end itemize -@item status: DCC status: -@itemize @minus -@item 0: waiting -@item 1: connecting -@item 2: active -@item 3: done -@item 4: failed -@item 5: aborted -@end itemize -@item start_time: date/time of DCC creation -@item start_transfer: date/time of transfer start -@item addr: remote address -@item port: port used for DCC -@item nick: remote nick -@item filename: filename -@item local_filename: local filename -@item size: file size -@item pos: current position in file -@item start_resume: restart position after interruption -@item bytes_per_sec: bytes sent/received per second -@end itemize -@* -@emph{Return value:}@* -@* -DCC list, 0 if error occured.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Python examples:}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, value );}@* -Python: @command{weechat.set_config ( option, value )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin"", -"#weechat");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl example:}@* -@* -@code{$value = weechat::get_plugin_config ("my_var");}@* -@* -@emph{Python example:}@* -@* -@code{$value = weechat.get_plugin_config ("my_var")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, value );}@* -Python: @command{weechat.set_plugin_config ( option, value )}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::set_plugin_config ("my_var", "value");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.set_plugin_config ("my_var", "value")}@* -@* - -@end itemize - - -@c **************************** Autores / Soporte ***************************** - -@node Autores / Soporte, , Plugins, Top -@chapter Autores / Soporte - -@ifhtml -@menu -* Autores:: -* Obtener soporte/ayuda:: -* Copyright:: -@end menu -@end ifhtml -@ifnothtml -@menu -* Autores:: -* Obtener soporte/ayuda:: -@end menu -@end ifnothtml - -@node Autores, Obtener soporte/ayuda, Autores / Soporte, Autores / Soporte -@section Autores - -WeeChat est@'a desarollado por:@* - -@itemize @bullet -@item -FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> - -@end itemize - -@ifhtml -@node Obtener soporte/ayuda, Copyright, Autores, Autores / Soporte -@end ifhtml -@ifnothtml -@node Obtener soporte/ayuda, , Autores, Autores / Soporte -@end ifnothtml -@section Obtener soporte/ayuda - -Antes de pedir ayuda al soporte, por favor lee la documentaci@'on y las FAQ de WeeChat.@* -(La documentaci@'on es el documento que est@'as leyendo, si no has leido todo hasta aqu@'i, -puedes hacerlo ahora ...)@* - -@itemize @bullet -@item -Soporte por IRC:@* -- servidor: @b{irc.freenode.net}@* -- canal: @b{#weechat}@*@* -@item -Foro WeeChat: @uref{http://forums.flashtux.org}@*@* -@item -Soporte mediante listas de difusi@'on:@* -- para apuntarse: @*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* -- para enviar un correo a la lista:@*@email{weechat-support@@nongnu.org}.@* - -Los archivos de la lista est@'an aqu@'i:@* -@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* -@item -Ver la p@'agina de soporte para WeeChat para m@'as detalles:@* -@uref{http://weechat.flashtux.org/support.php} - -@end itemize - -@ifhtml -@node Copyright, , Obtener soporte/ayuda, Autores / Soporte -@section Copyright - -Este manual documenta el cliente IRC WeeChat y hace parte del mismo proyecto WeeChat.@* - -Copyright @copyright{} 2005 FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* -Traducido en espa@~nol por Iznogoud <@email{iznogoud@@dlfp.org, iznogoud AT dlfp.org}>@* -@* -Este documento puede ser utilizado seg@'un los t@'erminos de la licencia GNU General Public License -versi@'on 2 o posterior. -@end ifhtml - -@bye diff --git a/doc/weechat_doc_fr.texi b/doc/weechat_doc_fr.texi deleted file mode 100644 index d3bb1e5f1..000000000 --- a/doc/weechat_doc_fr.texi +++ /dev/null @@ -1,2955 +0,0 @@ -\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) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@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 -@documentencoding ISO-8859-1 - -@titlepage - -@title WeeChat - Guide utilisateur -@subtitle Client IRC rapide, l@'eger et extensible -@subtitle Documentation pour WeeChat v0.1.7-cvs - 16 decembre 2005 - -@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{} 2005 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 (avec SSL, IPv6, proxy) -@item -plusieurs interfaces : Curses, wxWidgets, 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, MacOS X, 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{apt-get install weechat-curses} -@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 : @kbd{emerge weechat} -@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:: -* Fichier de configuration:: -* Raccourcis clavier:: -* Commandes WeeChat:: -* Tube FIFO:: -@end menu - -@node Lancer WeeChat, Fichier de configuration, Utilisation, Utilisation -@section Lancer WeeChat - -@subsection Param@`etres de ligne de commande - -@table @code -@item -a, --no-connect -Supprimer la connexion automatique aux serveurs lors du d@'emarrage@* -@item -c, --config -Afficher l'aide sur le fichier de config (liste des options)@* -@item -f, --key-functions -Afficher la liste des fonctions internes WeeChat pour les touches@* -@item -h, --help -Afficher l'aide@* -@item -i, --irc-commands -Afficher la liste des commandes IRC@* -@item -k, --keys -Afficher les touches par d@'efaut de WeeChat@* -@item -l, --license -Afficher la licence de WeeChat@* -@item -p, --no-plugin -Ne charger aucune extension lors du d@'emarrage@* -@item -v, --version -Afficher la version de WeeChat@* -@item -w, --weechat-commands -Afficher la liste des commandes WeeChat@* -@end table - -@subsection Lancer WeeChat - -Tapez simplement cette commande pour lancer WeeChat :@* -@kbd{weechat-curses} (pour l'interface Curses)@* -ou @kbd{weechat-wxwidgets} (pour l'interface wxWidgets)@* -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 Fichier de configuration, Raccourcis clavier, Lancer WeeChat, Utilisation -@section Fichier de configuration - -Liste des options du fichier de configuration :@* - -@table @kbd -@item look_set_title -D@'efinit le titre de la fen@^etre (terminal pour l'interface Curses) avec le nom et la version@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_startup_logo -Afficher le logo WeeChat au d@'emarrage@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_startup_version -Afficher la version de WeeChat au d@'emarrage@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_weechat_slogan -Slogan WeeChat (si vide, le slogan ne sera pas utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'the geekest IRC client!'@* -@item look_charset_decode_iso -Jeu de caract@`eres ISO pour d@'ecoder les messages du serveur (utilis@'e seulement si la locale est UTF-8) (si non renseign@'e, les messages ne sont pas concertis si la locale est UTF-8)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'ISO-8859-1'@* -@item look_charset_decode_utf -Jeu de caract@`eres UTF pour d@'ecoder les messages du serveur (utilis@'e seulement si la locale n'est pas UTF-8) (si non renseign@'e, les messages ne sont pas convertis si la locale n'est pas UTF-8)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'UTF-8'@* -@item look_charset_encode -Jeu de caract@`eres pour encoder les messages envoy@'es au serveur, exemples: UFT-8, ISO-8859-1 (si non renseign@'e, les messages ne sont pas convertis)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item look_charset_internal -Force le jeu de caract@`eres interne @`a WeeChat (doit @^etre vide dans la plupart des cas, ce qui signifie que le jeu de caract@`eres d@'etect@'e est utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item look_one_server_buffer -Utiliser le m@^eme tampon pour tous les serveurs@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item look_buffer_timestamp -Format de date/heure pour les tampons@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '[%H:%M:%S]'@* -@item look_color_nicks_number -Nombre de couleurs @`a utiliser pour les couleurs des pseudos@* -Type: entier (valeurs: entre 1 et 10), valeur par d@'efaut: 10@* -@item look_color_actions -Afficher les actions avec diff@'erentes couleurs@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_nicklist -Afficher la fen@^etre des utilisateurs (pour les fen@^etres de canaux)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_nicklist_position -Position de la fen@^etre d'utilisateurs (haut (top), gauche (left), droite (right, par d@'efaut), bas (bottom))@* -Type: cha@^ine (valeurs: 'left', 'right', 'top', 'bottom'), valeur par d@'efaut: 'right'@* -@item look_nicklist_min_size -Taille minimum pour la fen@^etre d'utilisateurs (largeur ou hauteur, selon look_nicklist_position (0 = pas de taille minimum))@* -Type: entier (valeurs: entre 0 et 100), valeur par d@'efaut: 0@* -@item look_nicklist_max_size -Taille maximum pour la fen@^etre d'utilisateurs (largeur ou hauteur, selon look_nicklist_position (0 = pas de taille maximum; si min == max et > 0, alors la taille est fixe))@* -Type: entier (valeurs: entre 0 et 100), valeur par d@'efaut: 0@* -@item look_no_nickname -Texte @`a afficher en lieu et place du nom d'utilisateur lorsque la connexion n'est pas active@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '-cmd-'@* -@item look_nickmode -Afficher le mode de l'utilisateur ((half)op/voice) devant chaque utilisateur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_nickmode_empty -Afficher un espace si le mode utilisateur n'est pas (half)op/voice@* -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 pseudos@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ':'@* -@item look_nick_completion_ignore -Caract@`eres @`a ignorer pour la compl@'etion des pseudos@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '[]-^'@* -@item look_infobar -Active la barre d'infos@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_infobar_timestamp -Format de date/heure dans la barre d'info@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%B, %A %d %Y'@* -@item look_infobar_seconds -Afficher les secondes pour l'heure dans la barre d'infos@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_infobar_delay_highlight -D@'elai (en secondes) pour la notification des messages dans la barre d'infos (0 = d@'esactiver les notifications dans la barre d'infos)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 7@* -@item look_hotlist_names_count -Nombre maximum de noms dans la liste d'activit@'e (0 = pas de nom affich@'e, seulement les num@'eros de tampons)@* -Type: entier (valeurs: entre 0 et 32), valeur par d@'efaut: 3@* -@item look_hotlist_names_level -Niveau pour l'affichage des noms dans la liste d'activit@'e (combinaison de: 1=join/part, 2=message, 4=priv@'e, 8=highlight, par exemple: 12=priv@'e+highlight)@* -Type: entier (valeurs: entre 1 et 15), valeur par d@'efaut: 12@* -@item look_hotlist_names_length -Nombre maximum des noms dans la liste d'activit@'e (0 = pas de limite)@* -Type: entier (valeurs: entre 0 et 32), valeur par d@'efaut: 0@* -@item look_day_change -Affiche un message quand le jour change@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_day_change_timestamp -Format de date pour la date affich@'ee quand le jour a chang@'e@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%a, %d %b %Y'@* -@item look_read_marker -Utiliser un marqueur sur les serveurs/canaux pour montrer la premi@`ere ligne non lue@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ' '@* -@item col_real_white -Si activ@'e, utilise la vraie couleur blanche, d@'esactiv@'e par d@'efaut pour les terminaux avec un fond blanc (si vous n'utilisez jamais de fond blanc, vous devriez activer cette option pour voir du vrai blanc au lieu de la couleur d'avant plant par d@'efaut du terminal)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item col_title -Couleur pour la barre de titre@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_title_bg -Couleur de fond pour la barre de titre@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_chat -Couleur pour le texte de discussion@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_chat_time -Couleur pour l'heure dans la fen@^etre de discussion@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_chat_time_sep -Couleur pour la s@'eparation de l'heure (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'brown'@* -@item col_chat_prefix1 -Couleur pour le 1er et le 3@`eme caract@`ere du pr@'efixe@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_chat_prefix2 -Couleur pour le caract@`ere du milieu du pr@'efixe@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_chat_server -Couleur pour le nom du serveur@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'brown'@* -@item col_chat_join -Couleur pour la fl@`eche du join (pr@'efixe)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_chat_part -Couleur pour la fl@`eche du part/quit (pr@'efixe)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightred'@* -@item col_chat_nick -Couleur pour les noms d'utilisateurs dans les actions (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_chat_host -Couleur pour les noms de machines (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_chat_channel -Couleur pour les canaux dans les actions (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_chat_dark -Couleur pour les s@'eparateurs sombres (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'green'@* -@item col_chat_highlight -Couleur pour le pseudo surlign@'e (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* -@item col_chat_bg -Couleur de fond pour la fen@^etre de discussion@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_chat_read_marker -Couleur pour le marqueur de donn@'ees non lues@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* -@item col_chat_read_marker_bg -Couleur de fond pour le marqueur de donn@'ees non lues@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'magenta'@* -@item col_status -Couleur pour la barre de statut@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@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_channel -Couleur pour le canal courant dans la barre de statut@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@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: 'yellow'@* -@item col_status_private -Couleur pour une fen@^etre avec un message priv@'e (barre de statut)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@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: 'lightred'@* -@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: 'default'@* -@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'@* -@item col_status_bg -Couleur de fond pour la fen@^etre de statut@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_infobar -Couleur pour la barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'black'@* -@item col_infobar_delimiters -Couleur pour les d@'elimiteurs de la barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_infobar_highlight -Couleur pour la notification dans la barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_infobar_bg -Couleur de fond pour la fen@^etre de barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_input -Couleur pour le texte saisi@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_input_channel -Couleur pour le texte saisi (nom du canal)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_input_nick -Couleur pour le texte saisi (pseudo)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_input_delimiters -Couleur pour le texte saisi (d@'elimiteurs)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_input_bg -Couleur de fond pour la fen@^etre de saisie@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_nick -Couleur pour les pseudos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_nick_away -Couleur pour les pseudos absents@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_nick_chanowner -Couleur pour le symbole du propri@'etaire du canal (sp@'ecifique @`a unrealircd)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_chanadmin -Couleur pour le symbole administrateur du canal (sp@'ecifique @`a unrealircd)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_op -Couleur pour le symbole op@'erateur@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_halfop -Couleur pour le symbole demi-op@'erateur@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@item col_nick_voice -Couleur pour le symbole voix@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* -@item col_nick_more -Couleur pour les '+' lors du scroll sur les pseudos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@item col_nick_sep -Couleur pour le s@'eparateur de pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_nick_self -Couleur pour le pseudo local@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_nick_color1 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_nick_color2 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'magenta'@* -@item col_nick_color3 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'green'@* -@item col_nick_color4 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'brown'@* -@item col_nick_color5 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightblue'@* -@item col_nick_color6 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_nick_color7 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_nick_color8 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@item col_nick_color9 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_color10 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_nick_private -Couleur pour l'autre pseudo dans la fen@^etre priv@'ee@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@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: 'lightcyan'@* -@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 history_display_default -Nombre maximum de commandes @`a afficher par d@'efaut dans le listing d'historique (0 = sans limite)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 5@* -@item log_auto_server -Enregistrer automatiquement les messages du serveur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item log_auto_channel -Enregistrer automatiquement les conversations des canaux@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item log_auto_private -Enregistrer automatiquement les conversations priv@'ees@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item log_plugin_msg -Enregistrer les messages des plugins (scripts)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@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_timestamp -Format de date/heure pour les conversations sauvegard@'ees (voir man strftime pour le format de date/heure)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Masquer le mot de passe affich@'e par nickserv@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item irc_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 irc_default_msg_away -Message par d@'efaut pour l'absence@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'away'@* -@item irc_default_msg_part -Message par d@'efaut pour le part (quitte un canal)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'WeeChat %v'@* -@item irc_default_msg_quit -Message de fin par d@'efaut ('%v' sera remplac@'e par la version de WeeChat dans la cha@^ine)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'WeeChat %v'@* -@item irc_notice_as_pv -Afficher les notices comme des messages priv@'es@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item irc_away_check -Intervalle entre deux v@'erifications des absences (en minutes, 0 = ne jemais v@'erifier)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 0@* -@item irc_lag_check -Intervalle entre deux mesures de lag (en secondes)@* -Type: entier (valeurs: entre 30 et 2147483647), valeur par d@'efaut: 60@* -@item irc_lag_min_show -Lag minimum @`a afficher (en secondes)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 1@* -@item irc_lag_disconnect -D@'econnexion apr@`es un lag important (en minutes, 0 = ne jamais se d@'econnecter)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 5@* -@item irc_fifo_pipe -Cr@'eer un tube FIFO pour le contr@^ole @`a distance@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item irc_highlight -Liste des mots pour la notification (s@'epar@'es par des virgules, le comparaison ne tient pas compte de la casse, les mots peuvent commencer ou se terminer par "*" pour une comparaison partielle)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item irc_colors_receive -Si d@'esactiv@'e, les codes couleurs des messages entrants sont ignor@'es@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item irc_colors_send -Autorise l'utilisateur @`a envoyer des couleurs avec des codes sp@'eciaux (%B=gras, %Cxx,yy=couleur, %U=soulign@'e, %R=invers@'e)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_accept_files -Accepte automatiquement les fichiers dcc entrants@* -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: 'off'@* -@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: 65536)@* -Type: entier (valeurs: entre 1024 et 102400), valeur par d@'efaut: 65536@* -@item dcc_port_range -Restreint le dcc sortant @`a utiliser des ports dans la plage donn@'ee (pratique pour le NAT) (syntaxe: un port simple, par exemple 5000, une plage de ports, par exemple 5000-5015, si non renseign@'e tout port peut @^etre utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item dcc_own_ip -Adresse IP ou DNS utilis@'ee pour le dcc sortant (si non renseign@'e, l'interface IP locale est utilis@'ee)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@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: '~'@* -@item dcc_upload_path -Chemin pour lire les fichiers lorsqu'ils sont envoy@'es par dcc (quand aucun chemin n'est sp@'ecifi@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~'@* -@item dcc_convert_spaces -Convertir les espaces en underscores lors d'envoi de fichiers@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_rename -Renommer les fichiers re@,{c}us s'ils existent d@'ej@`a (ajoute '.1', '.2', ...)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_resume -Continuer automatiquement les transferts dcc si la connexion avec la machine distante a @'et@'e perdue@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item proxy_use -Utiliser un proxy pour se connecter au serveur irc@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item proxy_type -Type de proxy (http (d@'efaut), socks4, socks5)@* -Type: cha@^ine (valeurs: 'http', 'socks4', 'socks5'), valeur par d@'efaut: 'http'@* -@item proxy_ipv6 -Se connecter au proxy en ipv6@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item proxy_address -Adresse du serveur proxy (IP ou nom)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item proxy_port -Port pour se connecter au serveur proxy@* -Type: entier (valeurs: entre 0 et 65535), valeur par d@'efaut: 3128@* -@item proxy_username -Nom d'utilisateur pour le serveur proxy@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item proxy_password -Mot de passe pour le serveur proxy@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item plugins_path -Chemin de recherche des extensions@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~/.weechat/plugins'@* -@item plugins_autoload -Liste des extensions @`a charger automatiquement au d@'emarrage, "*" signifie toutes (s@'epar@'ees par des virgules, les noms peuvent @^etre partiels, par exemple "perl" est ok pour "libperl.so")@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '*'@* -@item plugins_extension -Extension standard des extensions dans le nom de fichier, pour le chargement automatique (si vide, alors tous les fichiers sont charg@'es si autoload vaut "*")@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '.so'@* -@item server_name -Nom associ@'e au serveur IRC (pour affichage seulement)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_autoconnect -Connexion automatique au serveur quand WeeChat d@'emarre@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item server_autoreconnect -Reconnexion automatique au serveur apr@`es une d@'econnexion@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item server_autoreconnect_delay -D@'elai (en secondes) avant de tenter une reconnexion au serveur@* -Type: entier (valeurs: entre 0 et 65535), valeur par d@'efaut: 30@* -@item server_address -Adresse IP ou nom du serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_port -Port pour se connecter au serveur@* -Type: entier (valeurs: entre 0 et 65535), valeur par d@'efaut: 6667@* -@item server_ipv6 -Utiliser le protocole IPv6 pour la communication avec le serveur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item server_ssl -Utiliser SSL pour la communication avec le serveur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item server_password -Mot de passe pour le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_nick1 -Pseudo @`a utiliser sur le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_nick2 -Pseudo alternatif pour le serveur IRC (si le pseudo est d@'ej@`a utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_nick3 -2nd pseudo alternatif pour le serveur IRC (si le pseudo alternatif est d@'ej@`a utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_username -Nom d'utilisateur pour le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_realname -Nom r@'eel pour le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_command -Commande @`a ex@'ecuter en premier lorsque connect@'e au serveur@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_command_delay -D@'elai (en secondes) apr@`es ex@'ecution de la commande (exemple: donner du temps pour l'authentification)@* -Type: entier (valeurs: entre 0 et 5), valeur par d@'efaut: 0@* -@item server_autojoin -Liste des canaux (s@'epar@'es par des virgules) @`a rejoindre lorsque connect@'e au serveur (exemple: "#chan1,#chan2,#chan3 key1,key2")@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_autorejoin -Rejoindre automatiquement les canaux quand mis dehors@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item server_notify_levels -Liste des niveaux de notifications (s@'epar@'es par des virgules) pour les canaux de ce serveur (format: #canal:1,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_charset_decode_iso -Liste des jeux de caract@`eres (s@'epar@'es par des virgules) pour le serveur et les canaux, pour d@'ecoder l'ISO (format: server:charset,#canal:charset,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_charset_decode_utf -Liste des jeux de caract@`eres (s@'epar@'es par des virgules) pour le serveur et les canaux, pour d@'ecoder l'UTF (format: server:charset,#canal:charset,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_charset_encode -Liste des jeux de caract@`eres (s@'epar@'es par des virgules) pour le serveur et les canaux, pour encoder les messages (format: server:charset,#canal:charset,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@end table - -Les couleurs pour l'interface Curses sont :@* -@itemize @minus -@item -@kbd{default}: couleur par d@'efaut (transparent pour le fond) -@item -@kbd{black}: noir -@item -@kbd{red}: rouge fonc@'e -@item -@kbd{lightred}: rouge clair -@item -@kbd{green}: vert fonc@'e -@item -@kbd{lightgreen}: vert clair -@item -@kbd{brown}: marron -@item -@kbd{yellow}: jaune -@item -@kbd{blue}: bleu fonc@'e -@item -@kbd{lightblue}: bleu clair -@item -@kbd{magenta}: violet fonc@'e -@item -@kbd{lightmagenta}: violet clair -@item -@kbd{cyan}: cyan fonc@'e -@item -@kbd{lightcyan}: cyan clair -@item -@kbd{white}: blanc -@end itemize - -@node Raccourcis clavier, Commandes WeeChat, Fichier de configuration, 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 / Ctrl + A -Aller au d@'ebut de la ligne de commande@* -@* -@item End / Ctrl + E -Aller @`a la fin de la ligne de commande@* -@* -@item Ctrl + K -Efface jusqu'@`a la fin de la ligne@* -@* -@item Ctrl + L -R@'eaffiche toute la fen@^etre@* -@* -@item Ctrl + U -Efface jusqu'au d@'ebut de la ligne@* -@* -@item Ctrl + W -Effacer le mot pr@'ec@'edent sur la ligne de commande@* -@* -@item Backspace / Delete -Effacer le mot pr@'ec@'edent / suivant 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 Ctrl + fl@`eche haut / Ctrl + fl@`eche bas -Rappeler les derni@`eres commandes/messages dans l'historique global@* -@* -@item PageUp / PageDown -Afficher l'historique du tampon@* -@* -@item F5 / F6 -Aller au tampon pr@'ec@'edent / suivant@* -@* -@item F7 / F8 -Aller @`a la fen@^etre pr@'ec@'edente / suivante@* -@* -@item F10 -Effacer le dernier message de la barre d'infos@* -@* -@item F11 / F12 -Faire d@'efiler la liste des pseudos@* -@* -@item Alt + fl@`eche gauche / Alt + fl@`eche droite -Identique @`a F5 / F6@* -@* -@item Alt + A -Sauter au tampon avec activit@'e (avec priorit@'e: highlight, message, autre)@* -@* -@item Alt + B -Aller au mot pr@'ec@'edent@* -@* -@item Alt + D -Effacer le mot suivant@* -@* -@item Alt + F -Aller au mot suivant@* -@* -@item Alt + H -Vide la hotlist (notification d'activit@'e sur les autres tampons)@* -@* -@item Alt + J puis Alt + D -Afficher les DCC en cours@* -@* -@item Alt + J puis Alt + L -Sauter au dernier tampon@* -@* -@item Alt + J puis Alt + S -Sauter au tampon du serveur@* -@* -@item Alt + J puis Alt + X -Sauter au premier canal du serveur suivant (ou tampon du serveur si aucun canal ouvert)@* -@* -@item Alt + chiffre (1-9) -Sauter au tampon avec ce num@'ero@* -@* -@item Alt + J puis nombre (01-99) -Sauter au tampon avec ce num@'ero@* -@* -@item Alt + K -Capturer une touche -@* -@item Alt + N -Se positionner sur le highlight suivant@* -@* -@item Alt + P -Se positionner sur le highlight pr@'ec@'edent@* -@* -@item Alt + R -Effacer la ligne enti@`ere@* -@* -@item Alt + S -Changer de serveur sur le tampon des serveurs@* -(si l'option ``look_one_server_buffer'' est activ@'ee)@* -@* -@item Alt + U -Se positionner sur la premi@`ere ligne non lue du tampon@* -@* -@item Alt + W puis Alt + fl@`eche -Sauter @`a une fen@^etre avec une direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Faire d@'efiler la liste des pseudos@* -@* -@end table - -@node Commandes WeeChat, Tube FIFO, Raccourcis clavier, Utilisation -@section Commandes WeeChat - -Commandes internes WeeChat :@* - -@table @kbd -@item alias [nom_alias [commande [param@`etres]] -@* -cr@'eer un alias pour une commande@* -@* -nom_alias: nom de l'alias@* -commande: nom de la commande (commande WeeChat ou IRC, sans le premier '/')@* -param@`etres: param@`etres pour la commande@* -@* -@item buffer [action | nombre | [[serveur] [canal]]] -@* -gestion des tampons@* -@* -action: action @`a effectuer:@* - move: d@'eplacer le tampon dans la liste (peut @^etre relatif, par exemple -1)@* - close: fermer le tampon (pour un canal: @'equivalent @`a /part sans message de fin)@* - list: liste les tampons ouverts (pas de param@`etre affiche cette liste)@* - notify: fixer le niveau de notification (0=jamais, 1=highlight, 2=1+msg, 3=2+join/part)@* -serveur,canal: sauter au tampon par serveur et/ou nom de canal@* -nombre: sauter au tampon qui a ce num@'ero@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -changer le jeu de caract@`eres pour le serveur ou le canal@* -@* -decode_iso: jeu de caract@`eres utilis@'e pour d@'ecoder l'ISO@* -decode_utf: jeu de caract@`eres utilis@'e pour d@'ecoder l'UTF@* - encode: jeu de caract@`eres utilis@'e pour encoder les messages@* - charset: jeu de caract@`eres @`a utiliser (par exemple: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -effacer la/les fen@^etre(s)@* -@* --all: effacer toutes les fen@^etres@* -@* -@item connect [nom_serveur] -@* -se connecter @`a un serveur@* -@* -nom_serveur: nom du serveur pour se connecter@* -@* -@item disconnect [nom_serveur] -@* -se d@'econnecter d'un serveur@* -@* -nom_serveur: nom du serveur pour se d@'econnecter@* -@* -@item debug dump | windows -@* -affiche des messages de debuggage@* -@* -dump: affiche les variables m@'emoire WeeChat dans le fichier log (les m@^emes messages sont affich@'es lorsque WeeChat plante)@* -windows: affiche l'arbre des fen@^etres@* -@* -@item help [commande] -@* -afficher l'aide sur les commandes@* -@* -commande: nom d'une commande WeeChat ou IRC@* -@* -@item history [clear | valeur] -@* -affiche l'historique des commandes du tampon@* -@* -clear: effacer l'historique@* -valeur: nombre d'entr@'ees dans l'historique @`a afficher@* -@* -@item ignore [masque [[type | commande] [canal [serveur]]]] -@* -ignorer des messages IRC et/ou des masques@* -@* - masque: pseudo ou masque @`a ignorer@* - type: type de message @`a ignorer (action, ctcp, dcc, pv)@* -commande: commande IRC@* - canal: nom du canal pour le ignore@* - serveur: nom du serveur pour le ignore@* -@* -Pour chaque param@`etre, '*' signifie tou(te)s.@* -Sans param@`etre, la commande /ignore liste les ignore d@'efinis.@* -@* -@item key [touche fonction/commande] [unbind touche] [functions] [reset -yes] -@* -associer/lib@'erer des touches@* -@* -touche: associer cette touche @`a une fonction interne ou une commande (commen@,{c}ant par "/")@* -unbind: supprimer l'association @`a une touche (si "all", toutes les associations de touches par d@'efaut sont restaur@'ees)@* -functions: lister la liste des fonctions internes pour les associations de touches@* -reset: restaure les touches aux valeurs par d@'efaut et supprime TOUTES les touches personnelles (utiliser avec pr@'ecaution !)@* -@* -@item plugin [load fichier] | [autoload] | [reload] | [unload] -@* -liste/charge/d@'echarge des extensions@* -@* -fichier: extension WeeChat (fichier) @`a charger@* -@* -Sans param@`etre, la commande /plugin liste toutes les extensions charg@'ees.@* -@* -@item server [nom_serveur] | [nom_serveur nom/IP port [-auto | -noauto] [-ipv6] [-ssl] [-pwd mot_de_passe] [-nicks pseudo1 pseudo2 pseudo3] [-username nom_utilisateur] [-realname nom_r@'eel] [-command commande] [-autojoin canal[,canal]] ] | [del nom_serveur] -@* -liste, ajoute ou retire des serveurs@* -@* -nom_serveur: nom du serveur, pour usage interne et affichage@* -nom/IP: nom ou adresse IP du serveur@* -port: port pour le serveur (nombre entier)@* -ipv6: utiliser le protocole IPv6@* -ssl: utiliser le protocole SSL@* -mot_de_passe: mot de passe pour le serveur@* -pseudo1: premier pseudo pour le serveur@* -pseudo2: pseudo alternatif pour le serveur@* -pseudo3: second pseudo alternatif pour le serveur@* -nom_utilisateur: nom d'utilisateur@* -nom_r@'eel: nom r@'eel de l'utilisateur@* -@* -@item save [fichier] -@* -sauvegarder la configuration sur disque@* -@* -fichier: fichier pour sauvegarder la configuration@* -@* -@item set [option [ = valeur]] -@* -modifier des param@`etres de configuration@* -@* -option: nom de l'option (si le nom est complet et qu'aucune valeur n'est donn@'ee, alors l'aide sur l'option est affich@'ee)@* -valeur: valeur pour l'option@* -@* -@item unalias nom_alias -@* -supprimer un alias@* -@* -nom_alias: nom de l'alias @`a supprimer@* -@* -@item unignore [nombre | [masque [[type | commande] [canal [serveur]]]]] -@* -supprimer le ignore des messages IRC et/ou des masques@* -@* - nombre: num@'ero de ignore @`a supprimer (le nombre est affich@'e sur la liste des ignore)@* - masque: pseudo ou masque @`a ignorer@* - type: type de message @`a ignorer (action, ctcp, dcc, pv)@* -commande: commande IRC@* - canal: nom du canal pour le ignore@* - serveur: nom du serveur pour le ignore@* -@* -Pour chaque param@`etre, '*' signifie tou(te)s.@* -Sans param@`etre, /ignore liste les ignore d@'efinis.@* -@* -@item upgrade -@* -mettre @`a jour WeeChat sans se d@'econnecter des serveurs@* -@* -@item uptime [-o] -@* -montrer l'uptime de WeeChat@* -@* --o: envoyer l'uptime sur le canal courant en tant que message IRC@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [ptc] | resize pct | merge [all]] -@* -gestion des fen@^etres@* -@* -list: liste les fen@^etres ouvertes (pas de param@`etre affiche cette liste)@* --1: saute @`a la fen@^etre pr@'ec@'edente@* -+1: saute @`a la fen@^etre suivante@* -b#: saute @`a la fen@^etre affichant le tampon n°#@* -up: saute @`a la fen@^etre au dessus@* -down: saute @`a la fen@^etre au dessous@* -left: saute @`a la fen@^etre @`a gauche@* -right: saute @`a la fen@^etre @`a droite@* -splith: @'eclate la fen@^etre en deux horizontalement@* -splitv: @'eclate la fen@^etre en deux verticalement@* -resize: redimensionne une fen@^etre, la nouvelle taille est <pct>%% de la fen@^etre parent@* -merge: fusionne la fen@^etre avec une autre@* -@* -Pour splith et splitv, pct est un pourcentage qui repr@'esente la taille de la nouvelle fen@^etre, calcul@'ee par rapport @`a la taille de la fen@^etre courante. Par exemple 25 signifie cr@'eer une fen@^etre qui a pour taille: taille_courante / 4@* -@* -@end table - -Commandes IRC :@* - -@table @kbd -@item admin [cible] -@* -trouver les informations sur l'administrateur du serveur@* -@* -cible: serveur@* -@* -@item ame message -@* -envoyer une action CTCP @`a tous les canaux de tous les serveurs connect@'es@* -@* -message: message @`a envoyer@* -@* -@item amsg texte -@* -envoyer un message @`a tous les canaux de tous les serveurs connect@'es@* -@* -texte: texte @`a envoyer@* -@* -@item away [-all] [message] -@* -basculer le statut absent@* -@* --all: basculer le statut absent sur tous les serveurs connect@'es@* -message: message pour l'absence (si pas de message donn@'e, le statut d'absence est supprim@'e)@* -@* -@item ban [canal] [pseudo [pseudo ...]] -@* -bannit des pseudos ou masques@* -@* -canal: nom du canal pour le bannissement@* -pseudo: pseudo ou masque pour le bannissement@* -@* -@item ctcp pseudo type [arguments] -@* -envoyer un message CTCP (Client-To-Client Protocol)@* -@* -pseudo: utilisateur @`a qui envoyer le CTCP@* -type: type de CTCP (exemples: "version", "ping", etc...)@* -arguments: arguments pour le CTCP@* -@* -@item dcc action [pseudo [fichier]] -@* -d@'emarre le DCC (fichier ou discussion) ou ferme une discussion@* -@* -action: 'send' (envoi de fichier) ou 'chat' (discussion) ou 'close' (fermeture discussion)@* -pseudo: pseudo pour envoyer le fichier ou discuter@* -fichier: nom du fichier (sur la machine locale)@* -@* -@item dehalfop [pseudo [pseudo]] -@* -retire le statut de demi-op@'erateur du canal @`a/aux nick(s)@* -@* -@item deop [pseudo [pseudo]] -@* -retire le statut d'op@'erateur du canal @`a/aux nick(s)@* -@* -@item devoice [pseudo [pseudo]] -@* -retire la voix du/des pseudo(s)@* -@* -@item die -@* -arr@^eter le serveur@* -@* -@item halfop [pseudo [pseudo]] -@* -donner le statut de demi-op@'erateur @`a un/des utilisateur(s)@* -@* -@item info [cible] -@* -voir les informations d@'ecrivant le serveur@* -@* -cible: nom du serveur@* -@* -@item invite pseudo canal -@* -inviter un utilisateur sur un canal@* -@* -pseudo: utilisateur @`a inviter@* -channel: canal pour l'invitation@* -@* -@item ison pseudo [pseudo ...] -@* -v@'erifier si un utilisateur est actuellement sur IRC@* -@* -pseudo: pseudo@* -@* -@item join canal[,canal] [cl@'e[,cl@'e]] -@* -joindre un canal@* -@* -canal: nom du canal @`a rejoindre@* -cl@'e: cl@'e pour rejoindre le canal@* -@* -@item kick [canal] pseudo [commentaire] -@* -retirer par la force un utilisateur d'un canal@* -@* -canal: canal o@`u l'utilisateur se trouve@* -pseudo: utilisateur @`a @'eliminer@* -commentaire: commentaire pour l'@'elimination@* -@* -@item kickban [canal] pseudo [commentaire] -@* -retirer par la force un utilisateur d'un canal et le bannir@* -@* -canal: canal o@`u l'utilisateur se trouve@* -pseudo: utilisateur @`a @'eliminer et bannir@* -commentaire: commentaire pour l'@'elimination@* -@* -@item kill pseudo commentaire -@* -fermer la connexion client-serveur@* -@* -pseudo: utilisateur@* -commentaire: commentaire pour la mort@* -@* -@item links [[serveur] masque_serveur] -@* -lister tous les noms de serveurs connus du serveur qui r@'epondent @`a la requ@^ete@* -@* -serveur: ce serveur doit r@'epondre @`a la requ@^ete@* -masque_serveur: liste des serveurs correspondant au masque@* -@* -@item list [canal[,canall] [serveur]] -@* -lister les canaux et leur sujet@* -@* -canal: canal @`a lister@* -serveur: nom du serveur@* -@* -@item lusers [masque [cible]] -@* -obtenir des statistiques sur la taille du r@'eseau IRC@* -@* -masque: serveurs qui correspondent au masque seulement@* -cible: serveur pour faire suivre la requ@^ete@* -@* -@item me message -@* -envoyer une action CTCP au canal courant@* -@* -message: message @`a envoyer@* -@* -@item mode @{ canal @{[+|-]|o|p|s|i|t|n|b|v@} [limite] [utilisateur] [masque de banissement] @} | @{ nick @{[+|-]|i|w|s|o@} @} -@* -changer le mode du canal ou de l'utilisateur@* -@* -modes de canaux :@* - canal: nom du canal @`a modifier@* - o: donner/reprendre le statut privil@'egi@'e d'op@'erateur@* - p: indicateur de canal priv@'e@* - s: indicateur de canal secret@* - i: indicateur de canal avec invitation seulement@* - t: le titre est modifiable seulement par un op@'erateur du canal@* - n: aucun message au canal depuis l'ext@'erieur@* - m: canal mod@'er@'e@* - l: fixer la limite d'utilisateurs pour le canal@* - b: param@'etrer un masque de banissement pour garder des utilisateurs dehors@* - e: param@'etrer un masque d'exception@* - v: donner/reprendre la possibilit@'e de parler sur un canal mod@'er@'e@* - k: d@'efinir une cl@'e (mot de passe) pour acc@'eder au canal@* -modes utilisateur :@* - pseudo: utilisateur @`a modifier@* - i: marquer un utilisateur comme invisible@* - s: marquer un utilisateur pour recevoir les notices du serveur@* - w: l'utilisateur re@,{c}oit les wallops@* - o: drapeau op@'erateur@* -@* -@item motd [cible] -@* -obtenir le message du jour@* -@* -cible: nom du serveur@* -@* -@item msg cible[,cible] texte -@* -envoyer un message @`a un utilisateur ou canal@* -@* -cible: utilisateur ou canal (peut-@^etre un masque, '*' = canal courant)@* -texte: texte @`a envoyer@* -@* -@item names [canal[,canal]] -@* -lister les utilisateurs sur des canaux@* -@* -canal: nom du canal@* -@* -@item nick [-all] pseudo -@* -changer le pseudo courant@* -@* --all: d@'efinir le nouveau pseudo sur tous les serveurs connect@'es@* -pseudo: nouveau pseudo@* -@* -@item notice pseudo texte -@* -envoyer un message notice @`a un utilisateur@* -@* -pseudo: utilisateur cible pour la notice@* -texte: texte @`a envoyer@* -@* -@item op pseudo [pseudo] -@* -donner le statut op@'erateur @`a un/des utilisateur(s)@* -@* -@item oper utilisateur mot_de_passe -@* -obtenir le statut d'op@'erateur@* -@* -utilisateur/mot_de_passe: utilis@'e pour obtenir les privil@`eges sur le serveur IRC courant@* -@* -@item part [canal[,canall] [message_de_fin] -@* -quitter un canal@* -@* -canal: canal @`a quitter@* -message_de_fin: message de fin (affich@'e aux autres utilisateurs)@* -@* -@item ping serveur1 [serveur2] -@* -pinguer un serveur@* -@* -serveur1: serveur @`a pinguer@* -serveur2: faire suivre le ping @`a ce serveur@* -@* -@item pong d@'emon [d@'emon2] -@* -r@'epondre @`a un message ping@* -@* -d@'emon: d@'emon qui a r@'epondu au message Ping@* -d@'emon2: faire suivre le message @`a ce d@'emon@* -@* -@item query pseudo [texte] -@* -envoyer un message priv@'e @`a un utilisateur@* -@* -pseudo: utilisateur pour la conversation priv@'ee@* -texte: texte @`a envoyer@* -@* -@item quit [message_de_fin] -@* -fermer toutes les connexions et quitter@* -@* -message_de_fin: message de fin (affich@'e aux autres utilisateurs)@* -@* -@item quote donn@'ees -@* -envoyer des donn@'ees brutes au serveur sans analyse@* -@* -donn@'ees: donn@'ees brutes @`a envoyer@* -@* -@item rehash -@* -demander au serveur de recharger son fichier de configuration@* -@* -@item restart -@* -demander au serveur de red@'emarrer@* -@* -@item service pseudo r@'eserv@'e distribution type r@'eserv@'e info -@* -enregister un nouveau service@* -@* -distribution: visibilit@'e du service@* -type: r@'eserv@'e pour une utilisation future@* -@* -@item servlist [masque [type]] -@* -lister les services actuellement connect@'es au r@'eseau@* -@* -masque: lister seulement les services qui correspondent @`a ce masque@* -type: lister seulement les services de ce type@* -@* -@item squery service texte -@* -envoyer un message @`a un service@* -@* -service: nom du service@* -texte: texte @`a envoyer@* -@* -@item squit serveur commentaire -@* -d@'econnecter les liens vers un serveur@* -@* -serveur: nom du serveur@* -commentaire: commentaire pour quitter@* -@* -@item stats [requ@^ete [serveur]] -@* -demander des statistiques sur le serveur@* -@* -requ@^ete: c/h/i/k/l/m/o/y/u (voir la RFC1459)@* -serveur: nom du serveur@* -@* -@item summon utilisateur [cible [canal]] -@* -envoyer aux utilisateurs d'un serveur IRC un message leur demandant de rejoindre IRC@* -@* -utilisateur: nom d'utilisateur@* -cible: nom du serveur@* -canal: nom du canal@* -@* -@item time [cible] -@* -demander l'heure locale de serveur@* -@* -cible: demander l'heure de ce serveur@* -@* -@item topic [canal] [titre] -@* -recevoir/d@'efinir le titre du canal@* -@* -canal: nom du canal@* -titre: nouveau titre pour le canal (si le titre est "-delete" alors le titre est supprim@'e)@* -@* -@item trace [cible] -@* -trouver le chemin jusqu'@`a un serveur sp@'ecifique@* -@* -cible: serveur@* -@* -@item unban [canal] pseudo [pseudo ...] -@* -supprime le bannissement sur des pseudos ou masques@* -@* -canal: nom du canal pour supprimer le bannissement@* -pseudo: pseudo ou masque pour supprimer le bannissement@* -@* -@item userhost pseudo [pseudo ...] -@* -retourne une liste d'informations sur des utilisateurs@* -@* -pseudo: pseudo@* -@* -@item users [cible] -@* -liste des utilisateurs connect@'es au serveur@* -@* -cible: serveur@* -@* -@item version [serveur | pseudo] -@* -retourne la version de l'utilisateur ou du serveur (courant ou sp@'ecifi@'e)@* -@* -serveur: nom du serveur@* -pseudo: utilisateur@* -@* -@item voice [pseudo [pseudo]] -@* -donne la voix @`a/aux utilisateur(s)@* -@* -@item wallops texte -@* -envoyer un message @`a tous les utilisateurs connect@'es qui ont activ@'e le mode utilisateur 'w' pour eux-m@^emes@* -@* -texte @`a envoyer@* -@* -@item who [masque ["o"]] -@* -g@'en@`ere une requ@^ete qui retourne une liste d'information@* -@* -masque: information qui correspond @`a ce masque uniquement@* -o: seul les op@'erateurs sont retourn@'es correspondant au masque fourni@* -@* -@item whois [serveur] pseudo[,pseudo] -@* -demande les informations sur le(s) utilisateur(s)@* -@* -serveur: nom du serveur@* -pseudo: utilisateur (peut @^etre un masque)@* -@* -@item whowas pseudo [,pseudo [,pseudo ...]] [nombre [cible]] -@* -demander de l'information sur un nick qui n'existe plus@* -@* -pseudo: pseudo @`a chercher@* -nombre: nombre de r@'eponses @`a retourner (recherche compl@`ete si nombre n@'egatif)@* -cible: la r@'eponse doit correspondre @`a ce masque@* -@* -@end table - -Fonctions internes pour les touches :@* - -@table @kbd -@item return -terminer la ligne@* -@item tab -compl@'eter le mot@* -@item backspace -effacer le caract@`ere pr@'ec@'edent@* -@item delete -effacer le caract@`ere suivant@* -@item delete_end_line -effacer jusqu'@`a la fin de la ligne@* -@item delete_beginning_line -effacer jusqu'au d@'ebut de la ligne@* -@item delete_line -effacer la ligne enti@`ere@* -@item delete_previous_word -effacer le mot pr@'ec@'edent@* -@item delete_next_word -effacer le mot suivant@* -@item clipboard_paste -coller le contenu du presse-papier@* -@item transpose_chars -inverser les caract@`eres@* -@item home -aller au d@'ebut de la ligne@* -@item end -aller @`a la fin de la ligne@* -@item left -se d@'eplacer d'un caract@`ere @`a gauche@* -@item previous_word -se d@'eplacer au mot pr@'ec@'edent@* -@item right -se d@'eplacer d'un caract@`ere @`a droite@* -@item next_word -se d@'eplacer au mot suivant@* -@item up -appeler la commande pr@'ec@'edente dans l'historique@* -@item up_global -appeler la commande pr@'ec@'edente dans l'historique global@* -@item down -appeler la commande suivante dans l'historique@* -@item down_global -appeler la commande suivante dans l'historique global@* -@item page_up -faire d@'efiler d'une page vers le haut@* -@item page_down -faire d@'efiler d'une page vers le bas@* -@item nick_beginning -afficher le d@'ebut de la liste des pseudos@* -@item nick_end -afficher la fin de la liste des pseudos@* -@item nick_page_up -faire d@'efiler la liste des pseudos d'une page vers le haut@* -@item nick_page_down -faire d@'efiler la liste des pseudos d'une page vers le bas@* -@item jump_smart -sauter au tampon avec de l'activit@'e@* -@item jump_dcc -sauter au tampon DCC@* -@item jump_last_buffer -sauter au dernier tampon@* -@item jump_server -sauter au tampon du serveur@* -@item jump_next_server -sauter au prochain serveur@* -@item switch_server -bascule de serveur actif sur le tampon des serveurs@* -@item scroll_previous_highlight -scroller jusqu'au highlight pr@'ec@'edent du tampon@* -@item scroll_next_highlight -scroller jusqu'au highlight suivant du tampon@* -@item scroll_unread -scroller jusqu'@`a la premi@`ere ligne non lue du tampon@* -@item hotlist_clear -effacer la liste d'activit@'e@* -@item infobar_clear -effacer la barre d'infos@* -@item refresh -rafraichir l'@'ecran@* -@item grab_key -capturer une touche@* -@end table - -@node Tube FIFO, , Commandes WeeChat, Utilisation -@section Tube FIFO - -Vous pouvez contr@^oler WeeChat @`a distance, en envoyant des commandes ou du -texte dans un tube FIFO (l'option "irc_fifo_pipe" doit @^etre activ@'ee, elle -est d@'esactiv@'ee par d@'efaut).@* -Le tube FIFO est dans le r@'epertoire ~/.weechat/ et s'appelle "weechat_fifo_xxxxx" -(o@`u xxxxx est l'ID du processus (PID) du WeeChat qui tourne).@* -Donc si plusieurs WeeChat tournent, vous avez plusieurs tubes FIFO, un pour -chaque session.@* -@* -La syntaxe pour envoyer des commandes ou du texte dans le tube FIFO est la suivante :@* -@command{serveur,canal *texte ou commande ici}@* -o@`u le serveur et le canal sont facultatifs, mais si le canal est l@`a, le -serveur doit l'@^etre aussi.@* -@* -Quelques exemples : -@table @asis -@item @bullet{} changement du pseudo sur freenode en "pseudo|absent": -@* -@command{echo "freenode */nick pseudo|absent" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} affichage de texte sur le canal #weechat : -@* -@command{echo "freenode,#weechat *bonjour tout le monde !" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} affichage de texte sur le canal courant (le tampon affich@'e par WeeChat): -@* -@command{echo "*bonjour !" >~/.weechat/weechat_fifo_12345} -@* -@b{Attention :} ceci est dangereux et vous ne devriez pas le faire sauf si vous savez ce que vous faites ! -@* -@item @bullet{} envoyer deux commandes pour d@'echarger/recharger les scripts Perl (vous devez les s@'eparer par \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -Vous pouvez @'ecrire un script qui envoie les commandes @`a tous les WeeChat qui -tournent en m@^eme temps, par exemple :@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -Si le script s'appelle "auto_weechat_command", vous pouvez le lancer ainsi :@* -@command{./auto_weechat_command "freenode,#weechat *bonjour"} - - -@c ******************************* Extensions ********************************* - -@node Extensions, Auteurs / Support, Utilisation, Top -@chapter Extensions - -@menu -* Les extensions dans WeeChat:: -* Ecrire une extension:: -* Exemple d'extension:: -* Extensions pour scripts:: -@end menu - -@node Les extensions dans WeeChat, Ecrire une extension, Extensions, Extensions -@section Les extensions dans WeeChat - -Une extension (``plugin'' en anglais) est un programme @'ecrit en C -qui peut appeler des fonctions de WeeChat d@'efinies dans une -interface.@* -Ce programme C n'a pas besoin des sources WeeChat pour @^etre -compil@'e et peut @^etre charg@'e/d@'echarg@'e dynamiquement dans -WeeChat via la commande @command{/plugin}.@* -@* -L'extension doit @^etre au format biblioth@`eque, chargeable -dynamiquement par le syst@^eme d'exploitation.@* -Sous GNU/Linux, il s'agit d'un fichier ayant pour extension ``.so'', -sous Windows ``.dll''. - -@node Ecrire une extension, Exemple d'extension, Les extensions dans WeeChat, Extensions -@section Ecrire une extension - -@subsection R@`egles de base - -L'extension doit appeler le fichier ``weechat-plugin.h'' (disponible -dans les sources de WeeChat).@* -Ce fichier d@'efinit les structures et types dont l'extension aura -besoin pour communiquer avec WeeChat.@* -@* -L'extension doit comporter certaines variables et fonctions -obligatoires (sans quoi l'extension ne peut être chargée) :@* -@itemize @bullet -@item variables de description de l'extension : -@itemize @minus -@item plugin_name[]: le nom de l'extension -@item plugin_version[]: la version de l'extension -@item plugin_description[]: une courte description de l'extension -@end itemize -@item fonctions d'initialisation et fin de l'extension : -@itemize @minus -@item weechat_plugin_init: fonction appel@'ee au chargement de l'extension, -qui doit renvoyer PLUGIN_RC_OK (0) en cas de succ@`es, PLUGIN_RC_KO (-1) -en cas d'erreur -@item weechat_plugin_end: fonction appel@'ee au d@'echargement de l'extension -@end itemize -@end itemize - -@subsection Fonctions de l'interface (API) - -L'extension peut appeler un certain nombre de fonctions d@'efinies -dans la structure t_weechat_plugin.@* -@* -Ces fonctions sont d@'etaill@'ees ci-dessous :@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Effectue une comparaison entre deux cha@^ines, sans tenir compte des -majuscules/minuscules ni de la locale.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string1}: la premi@`ere cha@^ine @`a comparer -@item @option{string2}: la deuxi@`eme cha@^ine @`a comparer -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La diff@'erence entre les deux cha@^ines: n@'egatif si chaine1 < -chaine2, nul si chaine1 == chaine 2, positif si chaine1 > chaine2@* -@* -@emph{Exemple :}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Effectue une comparaison entre deux cha@^ines, sans tenir compte des -majuscules/minuscules ni de la locale, en comparant au plus ``max'' -caract@`eres.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string1}: la premi@`ere cha@^ine @`a comparer -@item @option{string2}: la deuxi@`eme cha@^ine @`a comparer -@item @option{max}: nombre de caract@`eres max @`a comparer -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La diff@'erence entre les deux cha@^ines: n@'egatif si chaine1 < -chaine2, nul si chaine1 == chaine 2, positif si chaine1 > chaine2@* -@* -@emph{Exemple :}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explose une cha@^ine en plusieurs selon un/des d@'elimiteur(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string}: la cha@^ine @`a exploser -@item @option{separators}: les d@'elimiteurs utilis@'es pour exploser -la cha@^ine -@item @option{num_items_max}: nombre maximum de sous-cha@^ines -cr@'e@'ees (si 0, alors le nombre est infini) -@item @option{num_items}: pointeur vers un entier qui contiendra le -nombre de sous-cha@^ines cr@'e@'ees en retour -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Un tableau de cha@^ines, ou NULL si un probl@^eme a @'et@'e rencontr@'e.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free_exploded_string'' apr@`es utilisation.@* -@* -@emph{Exemple :}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Lib@`ere la m@'emoire utilis@'ee pour une explosion de cha@^ine.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string}: la cha@^ine explos@'ee par la fonction -``explode_string'' -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Ex@'ecute une fonction sur tous les fichiers d'un r@'epertoire.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{directory}: le r@'epertoire o@`u les fichiers sont -recherch@'es -@item @option{callback}: une fonction appel@'ee pour chaque fichier trouv@'e -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "fichier: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Affiche un message sur un tampon WeeChat, identifi@'e par le serveur et -le canal (tous deux pouvant @^etre NULL pour le tampon courant).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{server}: nom du serveur pour trouver le tampon dans -lequel afficher (peut @^etre NULL) -@item @option{channel}: nom du canal pour trouver le tampon dans -lequel afficher (peut @^etre NULL) -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemples :}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Affiche un message sur la fen@^etre du serveur courant.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Affiche un message sur la barre d'infos pour un temps d@'etermin@'e.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{time}: temps pendant lequel le message est affich@'e, en -secondes (0 = jamais effac@'e) -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Ajoute un gestionnaire de messages IRC, appel@'e d@`es qu'un message -IRC est re@,cu.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{message}: message IRC (par exemple ``PRIVMSG'') -@item @option{handler_func}: fonction appel@'ee lorsque le message est -re@,cu -@item @option{handler_args}: param@`etres pass@'es @`a la fonction -appel@'ee -@item @option{handler_pointer}: pointeur pass@'e @`a la fonction -appel@'ee -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Le pointeur vers le nouveau gestionnaire de messages.@* -@* -@emph{Exemple :}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK re@,cu");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une -des valeurs suivantes (pr@'efix@'ee par ``weechat::'' pour Perl ou -``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: le message ne sera pas transmis -@`a WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: le message ne sera pas transmis -@`a d'autres extensions -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: le message ne sera transmis ni @`a -WeeChat ni @`a d'autres extensions -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Ajoute un gestionnaire de commande WeeChat, appel@'e d@`es que -l'utilisateur utilise la commande (par exemple /commande).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{commande}: la nouvelle commande -@item @option{description}: description de la commande (affich@'ee par -/help commande) -@item @option{arguments}: br@`eve description des param@`etres de la -commande (affich@'ee par /help commande) -@item @option{arguments_description}: longue description des -param@`etres de la commande (affich@'ee par /help commande) -@item @option{completion_template}: mod@`ele pour la compl@'etion, sous -la forme @code{abc|%w def|%i} qui signifie ``abc'' ou une comande -WeeChat pour le premier param@`etre, et ``def'' ou une commande IRC -pour le deuxi@`eme.@* -Les codes suivants peuvent @^etre utilis@'es : -@itemize @minus -@item @code{%-}: aucune compl@'etion pour le param@`etre -@item @code{%a}: alias -@item @code{%A}: alias et commandes (WeeChat, IRC et extensions) -@item @code{%c}: canal courant -@item @code{%C}: canaux du serveur courant -@item @code{%f}: nom de fichier -@item @code{%h}: commandes d@'efinies par des extensions -@item @code{%i}: commandes IRC (envoy@'ees) -@item @code{%I}: commandes IRC (re@,cues) -@item @code{%k}: touches -@item @code{%n}: pseudos du canal courant -@item @code{%o}: option de configuration -@item @code{%p}: message de ``part'' par d@'efaut -@item @code{%q}: message de ``quit'' par d@'efaut -@item @code{%s}: nom du serveur courant -@item @code{%S}: noms de tous les serveurs -@item @code{%t}: titre du canal courant -@item @code{%v}: valeur d'une option de configuration -@item @code{%w}: commandes WeeChat -@item @code{%y}: message d'absence (``away'') par d@'efaut -@end itemize -@item @option{handler_func}: fonction appel@'ee lorsque la commande est -ex@'ecut@'ee -@item @option{handler_args}: param@`etres pass@'es @`a la fonction -appel@'ee -@item @option{handler_pointer}: pointeur pass@'e @`a la fonction -appel@'ee -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Le pointeur vers le nouveau gestionnaire de commande.@* -@* -@emph{Exemple :}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "commande test, -fichier: %s", (arguments) ? arguments : "aucun");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Commande test", -"[fichier]", "fichier: un nom de fichier", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit -renvoyer une des valeurs suivantes (pr@'efix@'ee par ``weechat::'' -pour Perl ou ``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Supprime un gestionnaire.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{handler}: le gestionnaire @`a supprimer -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Supprime tous les gestionnaires d'une extension.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute une commande WeeChat (ou envoie un message @`a un canal).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{server}: nom du serveur o@`u ex@'ecuter la commande -(peut @^etre NULL) -@item @option{channel}: nom du canal o@`u ex@'ecuter la commande (peut -@^etre NULL) -@item @option{command}: la commande @`a ex@'ecuter -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemples :}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Renvoie une information sur WeeChat ou un canal.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{info}: nom de l'info @`a obtenir : -@itemize @minus -@item @option{version}: obtenir la version de WeeChat -@item @option{nick}: obtenir le pseudo -@item @option{channel}: obtenir le nom du canal -@item @option{server}: obtenir le nom du serveur -@item @option{away}: obtenir le drapeau ``away'' -@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat -@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' -syst@`eme de WeeChat -@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' -syst@`eme de partage WeeChat -@end itemize -@item @option{server}: nom du serveur o@`u r@'ecup@'erer l'information -(ni n@'ecessaire) -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -L'information recherch@'ee, NULL si non trouv@'ee.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free'' apr@`es utilisation.@* -@* -@emph{Exemples :}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Renvoie la liste des DCC en cours ou termin@'es.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La liste cha@^in@'ee des DCC.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free_dcc_info'' apr@`es utilisation.@* -@* -@emph{Exemple :}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, avec: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Lib@`ere la m@'emoire utilis@'ee par une liste de DCC.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{dcc_info}: pointeur vers une structure renvoy@'ee par la -fonction ``get_dcc_info'' -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Renvoie la valeur d'une option de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a lire -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, NULL si non trouv@'ee.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free'' apr@`es utilisation.@* -@* -@emph{Exemples :}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_set_title");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Modifie la valeur d'une option de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a mettre @`a jour -@item @option{value}: nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si l'option a @'et@'e modifi@'ee avec succ@`es, 0 si une erreur -s'est produite.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Renvoie la valeur d'une option de l'extension.@* -L'option est lue depuis le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.option=valeur}@* -NB: le nom de l'extension est ajout@'e automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a lire -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, NULL si non trouv@'ee.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free'' apr@`es utilisation.@* -@* -@emph{Exemple :}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "ma_variable");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Modifie la valeur d'une option de l'extension.@* -L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.option=valeur}@* -NB: le nom de l'extension est ajout@'e automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a mettre @`a jour -@item @option{value}: nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si l'option a @'et@'e modifi@'ee avec succ@`es, 0 si une erreur -s'est produite.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->set_plugin_config (plugin, "ma_variable", "valeur");}@* -@* - -@end itemize - -@subsection Compiler l'extension - -La compilation ne n@'ecessite pas les sources WeeChat, mais seulement -le fichier ``weechat-plugin.h''.@* - -Pour compiler une extension compos@'ee d'un fichier ``toto.c'' (sous -GNU/Linux) :@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Charger l'extension dans WeeChat - -Copier le fichier ``libtoto.so'' dans le r@'epertoire des extensions -g@'en@'eral (par exemple /usr/local/lib/weechat/plugins) ou bien dans -celui de l'utilisateur (par exemple /home/xxxxx/.weechat/plugins).@* -@* -Sous WeeChat :@* -@command{/plugin load toto} - -@node Exemple d'extension, Extensions pour scripts, Ecrire une extension, Extensions -@section Exemple d'extension - -Un exemple complet d'extension, qui ajoute une commande /double -affichant deux fois les param@`etres pass@'es sur le canal courant -(d'accord ce n'est pas tr@`es utile mais ceci est un exemple !) :@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Plugin de test pour WeeChat"; - -/* gestionnaire de commande "/hello" */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Affiche deux fois un message", - "msg", - "msg: message a afficher deux fois", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* on ne fait rien ici */ -} -@end verbatim - -@node Extensions pour scripts, , Exemple d'extension, Extensions -@section Extensions pour scripts - -Trois extensions sont fournies en standard avec WeeChat pour utiliser -des langages de script: Perl, Python et Ruby. - -@subsection Charger/d@'echarger des scripts - -Les scripts sont charg@'es et d@'echarg@'es avec les commandes -@command{/perl}, @command{/python} et @command{/ruby}. -(tapez @kbd{/help} dans WeeChat pour obtenir de l'aide sur les -commandes).@* - -@emph{Exemples :}@* -@itemize @bullet -@item -Charger un script Perl : @kbd{/perl load /tmp/essai.pl}@* -@item -D@'echarger tous les scripts Perl : @kbd{/perl unload}@* -@item -Lister les scripts Perl charg@'es : @kbd{/perl}@* -@item -Charger un script Python : @kbd{/python load /tmp/essai.py}@* -@item -D@'echarger tous les scripts Python : @kbd{/python unload}@* -@item -Lister les scripts Python charg@'es : @kbd{/python}@* -@end itemize - -@subsection Interface WeeChat / Scripts - -@itemize @bullet -@item -Perl: @command{weechat::register ( nom, version, fonction_de_fin, -description );}@* -Python: @command{weechat.register ( nom, version, fonction_de_fin, -description )}@* -@* -C'est la premi@`ere fonction @`a appeler dans le script.@* -Tout script 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 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{Valeur renvoy@'ee :}@* -@* -1 si le script a @'et@'e enregistr@'e, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.register ("essai", "1.0", "fin_essai", "Script d'essai !")}@* -@* - -@item -Perl: @command{weechat::print ( message, [canal, [serveur]] );}@* -Python: @command{weechat.prnt ( message, [canal, [serveur]] )}@* -@* -Affiche un message dans un canal.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{message}: message @`a afficher -@item @option{canal}: nom du canal -@item @option{serveur}: nom interne du serveur -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( d@'elai, message );}@* -Python: @command{weechat.print_infobar ( d@'elai, message )}@* -@* -Affiche un message dans la barre d'infos.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{d@'elai}: d@'elai (en secondes) pendant lequel le message est affich@'e -(si 0, le message ne sera pas effac@'e). -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( nom, fonction );}@* -Python: @command{weechat.add_message_handler ( nom, fonction )}@* -@* -Attache une fonction @`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 appel@'ee lorsque le message est re@,{c}u -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si la fonction a @'et@'e attach@'ee, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::add_message_handler ("privmsg", ma_fonction);}@* -@code{sub ma_fonction}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("serveur=$_[0]\n");}@* -@code{@ @ @ @ ($null, $canal, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* -@code{@ @ @ @ weechat::print ("masque=$masque, canal=$canal, msg=$message\n");}@* -@code{@ @ @ @ return weechat::PLUGIN_RC_OK;}@* -@code{@} }@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.add_message_handler ("privmsg", ma_fonction)}@* -@code{def ma_fonction(serveur, args):}@* -@code{@ @ @ @ weechat.prnt("serveur="+serveur)}@* -@code{@ @ @ @ null, canal, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ masque, null, canal = string.split(string.strip(canal), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("masque="+masque+", canal="+canal+", message="+message)}@* -@code{@ @ @ @ return weechat.PLUGIN_RC_OK}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une -des valeurs suivantes (pr@'efix@'ee par ``weechat::'' pour Perl ou -``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: le message ne sera pas -transmis @`a WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: le message ne sera pas -transmis @`a d'autres extensions -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: le message ne sera transmis ni -@`a WeeChat ni @`a d'autres extensions -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( nom, fonction, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( nom, fonction, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Cr@'e@'e une nouvelle commande WeeChat, associ@'ee @`a une fonction.@* -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 du script. Soyez prudent en @'ecrasant les -commandes WeeChat, car elles ne seront plus accessibles tant que le -script sera charg@'e. -@item @option{fonction}: fonction associ@'ee @`a la commande -@item @option{description}: description de la commande (affich@'ee par -/help commande) -@item @option{arguments}: br@`eve description des param@`etres de la -commande (affich@'ee par /help commande) -@item @option{arguments_description}: longue description des -param@`etres de la commande (affich@'ee par /help commande) -@item @option{completion_template}: mod@`ele pour la compl@'etion, sous -la forme @code{abc|%w def|%i} qui signifie ``abc'' ou une comande -WeeChat pour le premier param@`etre, et ``def'' ou une commande IRC -pour le deuxi@`eme.@* -Les codes suivants peuvent @^etre utilis@'es : -@itemize @minus -@item @code{%-}: aucune compl@'etion pour le param@`etre -@item @code{%a}: alias -@item @code{%A}: alias et commandes (WeeChat, IRC et extensions) -@item @code{%c}: canal courant -@item @code{%C}: canaux du serveur courant -@item @code{%f}: nom de fichier -@item @code{%h}: commandes d@'efinies par des extensions -@item @code{%i}: commandes IRC (envoy@'ees) -@item @code{%I}: commandes IRC (re@,cues) -@item @code{%k}: touches -@item @code{%n}: pseudos du canal courant -@item @code{%o}: option de configuration -@item @code{%p}: message de ``part'' par d@'efaut -@item @code{%q}: message de ``quit'' par d@'efaut -@item @code{%s}: nom du serveur courant -@item @code{%S}: noms de tous les serveurs -@item @code{%t}: titre du canal courant -@item @code{%v}: valeur d'une option de configuration -@item @code{%w}: commandes WeeChat -@item @code{%y}: message d'absence (``away'') par d@'efaut -@end itemize -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si la fonction a @'et@'e attach@'ee, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::add_command_handler ("commande", ma_commande);}@* -@code{sub ma_commande}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Serveur: $_[0], param@`etres: $_[1]\n");}@* -@code{@ @ @ @ return weechat::PLUGIN_RC_OK;}@* -@code{@} }@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.add_command_handler ("commande", ma_commande)}@* -@code{def ma_commande(serveur, args):}@* -@code{@ @ @ @ weechat.prnt("serveur:"+serveur+" param@`etres:"+args)}@* -@code{@ @ @ @ return weechat.PLUGIN_RC_OK}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit -renvoyer une des valeurs suivantes (pr@'efix@'ee par ``weechat::'' -pour Perl ou ``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( nom, fonction );}@* -Python: @command{weechat.remove_handler ( nom, fonction )}@* -@* -Supprime un gestionnaire de message ou de commande.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{nom}: nom du message IRC ou de la commande -@item @option{fonction}: fonction associ@'ee -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::remove_handler ("commande", ma_commande);}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.remove_handler ("commande", ma_commande)}@* -@* - -@item -Perl: @command{weechat::command ( commande, [canal, [serveur]] );}@* -Python: @command{weechat.command ( commande, [canal, [serveur]] )}@* -@* -Ex@'ecute une commande ou envoie un message @'a un canal.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{commande}: commande @'a ex@'ecuter (ou message @'a -envoyer au canal) -@item @option{canal}: nom du canal -@item @option{serveur}: nom interne du serveur -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{weechat::command ("bonjour tout le monde !");}@* -@code{weechat::command ("/kick toto merci de quitter ce canal", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{weechat.command ("bonjour tout le monde !")}@* -@code{weechat.command ("/kick toto merci de quitter ce canal", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( nom, [serveur] );}@* -Python: @command{weechat.get_info ( nom, [serveur] )}@* -@* -Obtenir des informations vari@'ees sur WeeChat, le serveur ou -l'utilisateur.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{nom}: nom de l'info @`a obtenir : -@itemize @minus -@item @option{version}: obtenir la version de WeeChat -@item @option{nick}: obtenir le pseudo -@item @option{channel}: obtenir le nom du canal -@item @option{server}: obtenir le nom du serveur -@item @option{away}: obtenir le drapeau ``away'' -@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat -@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' -syst@`eme de WeeChat -@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' -syst@`eme de partage WeeChat -@end itemize -@item @option{serveur}: nom interne du serveur -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -L'information demand@'e, blanc si une erreur s'est produite ou que -l'information n'a pas @'et@'e trouv@'ee.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{$version = get_info("version");}@* -@code{$nick = get_info("nick", "freenode");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{$version = weechat.get_info ("version")}@* -@code{$nick = weechat.get_info ("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( )}@* -@* -Obtenir la liste des DCC.@* - -Le tableau renvoy@'e contient les champs suivants : -@itemize @minus -@item server: le serveur IRC -@item channel: le canal IRC -@item type: le type de DCC : -@itemize @minus -@item 0: discussion (re@,cue) -@item 1: discussion (envoy@'ee) -@item 2: fichier en r@'eception -@item 3: fichier en @'emission -@end itemize -@item status: statut du DCC : -@itemize @minus -@item 0: en attente -@item 1: en cours de connexion -@item 2: actif -@item 3: termin@'e -@item 4: @'echou@'e -@item 5: interrompu par l'utilisateur -@end itemize -@item start_time: la date et heure de cr@'eation du DCC -@item start_transfer: la date et heure de d@'emarrage du transfert -@item addr: adresse de l'utilisateur distant -@item port: port utilis@'e pour le DCC -@item nick: pseudo de l'utilisateur distant -@item filename: nom de fichier -@item local_filename: nom de fichier local -@item size: taille du fichier -@item pos: position actuelle dans le fichier -@item start_resume: position de d@'emarrage apr@`es une interruption -@item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La liste des DCC, 0 si une erreur s'est produite.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Obtenir la valeur d'une option de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, blanc si une erreur s'est produite ou que -l'option n'a pas @'et@'e trouv@'ee.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, valeur );}@* -Python: @command{weechat.set_config ( option, valeur )}@* -@* -Modifier une otion de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@item @option{valeur}: la nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin, "#weechat");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin, "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Renvoie la valeur d'une option de l'extension.@* -L'option est lue depuis le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.script.option=valeur}@* -NB: le nom de l'extension et du script sont ajout@'es automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, blanc si une erreur s'est produite ou que -l'option n'a pas @'et@'e trouv@'ee.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{$value = weechat::get_plugin_config ("ma_variable");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{$value = weechat.get_plugin_config ("ma_variable")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, valeur );}@* -Python: @command{weechat.set_plugin_config ( option, valeur )}@* -@* -Modifie la valeur d'une option de l'extension.@* -L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.script.option=valeur}@* -NB: le nom de l'extension et du script sont ajout@'es automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@item @option{valeur}: la nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::set_plugin_config ("ma_variable", "valeur");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.set_plugin_config ("ma_variable", "valeur")}@* -@* - -@end itemize - - -@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}> - -@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 : @uref{http://forums.flashtux.org}@*@* -@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{} 2005 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 deleted file mode 100644 index f2492f758..000000000 --- a/doc/weechat_doc_pt.texi +++ /dev/null @@ -1,2907 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename weechat_doc_pt.info -@settitle WeeChat - Um cliente de IRC rapido, leve e extencivel -@c %**end of header - -@c WeeChat documentation (vers@~ao partuguesa) -@c -@c Copyright (c) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@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 -@documentencoding ISO-8859-1 - -@titlepage - -@title WeeChat - Guia do Utilizador -@subtitle Cliente de IRC rapido, leve e extencivel -@subtitle Documenta@,{c}@~ao do WeeChat v0.1.7-cvs - 16 de dezembro de 2005 - -@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{} 2005 FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* -@* -Este documento pode ser utilizado sobre os termos da Licen@,{c}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, Introducao, (dir), (dir) -@menu -* Introducao:: Descri@,{c}@~ao do WeeChat -* Instalacao:: Instala@,{c}@~ao do WeeChat -* Utilizacao:: Utiliza@,{c}@~ao do WeeChat -* Plugins:: WeeChat plugins -* Autores/Suporte:: Contactar os autores e obter suporte -@end menu - - -@c ******************************* Introducao ******************************* - -@node Introducao, Instalacao, Top, Top -@chapter Introdu@,{c}@~ao -@menu -* Descricao:: -* Pre-requisitos:: -@end menu - -@node Descricao, Pre-requisitos, Introducao, Introducao -@section Descri@,{c}@~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 (com SSL, IPv6, proxy) -@item -v@'arias interfaces : Curses, wxWidgets, 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, MacOS X, 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, ,Descricao, Introducao -@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 ******************************* Instalacao ******************************* - -@node Instalacao, Utilizacao, Introducao, Top -@chapter Instala@,{c}@~ao -@menu -* Binarios:: -* Codigo Fonte:: -* Codigo Fonte via CVS:: -@end menu - -@node Binarios, Codigo Fonte, Instalacao, Instalacao -@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{apt-get install weechat-curses} -@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 : @kbd{emerge weechat} -@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, Instalacao -@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, Instalacao -@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 ******************************* Utilizacao ******************************** - -@node Utilizacao, Plugins, Instalacao, Top -@chapter Utiliza@,{c}@~ao - -@menu -* Invocar o WeeChat:: -* Config file:: -* Recursos de teclado:: -* Comandos do WeeChat:: -* FIFO pipe:: -@end menu - -@node Invocar o WeeChat, Config file, Utilizacao, Utilizacao -@section Invocar o WeeChat - -@subsection Par@^ametros de linha de comandos - -@table @code -@item -a, --no-connect -Disable auto-connect to servers at startup@* -@item -c, --config -Mostrar da lima dos config da exposi@,{c}@~ao (lista das op@,{c}@~oes) -@item -f, --key-functions -Display WeeChat internal functions for keys@* -@item -h, --help -Mostrar a ajuda@* -@item -i, --irc-commands -Display IRC commands list@* -@item -k, --keys -Display WeeChat default keys@* -@item -l, --license -Mostrar a licen@,{c}a do WeeChat@* -@item -p, --no-plugin -Don't load any plugin at startup -@item -v, --version -Mostrar a vers@~ao do WeeChat@* -@item -w, --weechat-commands -Display WeeChat commands list@* -@end table - -@subsection Invocar o WeeChat - -Escreve simplesmente este comando para invoceres o WeeChat :@* -@kbd{weechat-curses} (para a interface em Curses)@* -ou @kbd{weechat-wxwidgets} (para a interface em wxWidgets)@* -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 Config file, Recursos de teclado, Invocar o WeeChat, Utilizacao -@section Config file - -List of options for config file:@* - -@table @kbd -@item look_set_title -Set title for window (terminal for Curses GUI) with name & version@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_logo -Display WeeChat logo at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_version -Display WeeChat version at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_weechat_slogan -WeeChat slogan (if empty, slogan is not used)@* -Type: string (any string), default value: 'the geekest IRC client!'@* -@item look_charset_decode_iso -ISO charset for decoding messages from server (used only if locale is UTF-8) (if empty, messages are not converted if locale is UTF-8@* -Type: string (any string), default value: 'ISO-8859-1'@* -@item look_charset_decode_utf -UTF charset for decoding messages from server (used only if locale is not UTF-8) (if empty, messages are not converted if locale is not UTF-8@* -Type: string (any string), default value: 'UTF-8'@* -@item look_charset_encode -Charset for encoding messages sent to server, examples: UFT-8, ISO-8859-1 (if empty, messages are not converted)@* -Type: string (any string), default value: ''@* -@item look_charset_internal -Forces internal WeeChat charset (should be empty in most cases, that means detected charset is used)@* -Type: string (any string), default value: ''@* -@item look_one_server_buffer -Use same buffer for all servers@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item look_buffer_timestamp -Timestamp for buffers@* -Type: string (any string), default value: '[%H:%M:%S]'@* -@item look_color_nicks_number -Number of colors to use for nicks colors@* -Type: integer (values: between 1 and 10), default value: 10@* -@item look_color_actions -Display actions with different colors@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist -Display nicklist window (for channel windows)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist_position -Nicklist position (top, left, right (default), bottom)@* -Type: string (values: 'left', 'right', 'top', 'bottom'), default value: 'right'@* -@item look_nicklist_min_size -Min size for nicklist (width or height, depending on look_nicklist_position (0 = no min size))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_nicklist_max_size -Max size for nicklist (width or height, depending on look_nicklist_position (0 = no max size; if min == max and > 0, then size is fixed))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_no_nickname -Text to display instead of nick when not connected@* -Type: string (any string), default value: '-cmd-'@* -@item look_nickmode -Display nick mode ((half)op/voice) before each nick@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nickmode_empty -Display space if nick mode is not (half)op/voice@* -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_nick_completion_ignore -Chars ignored for nick completion@* -Type: string (any string), default value: '[]-^'@* -@item look_infobar -Enable info bar@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_timestamp -Timestamp for time in infobar@* -Type: string (any string), default value: '%B, %A %d %Y'@* -@item look_infobar_seconds -Display seconds in infobar time@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_delay_highlight -Delay (in seconds) for highlight messages in infobar (0 = disable highlight notifications in infobar)@* -Type: integer (values: between 0 and 2147483647), default value: 7@* -@item look_hotlist_names_count -Max number of names in hotlist (0 = no name displayed, only buffer numbers)@* -Type: integer (values: between 0 and 32), default value: 3@* -@item look_hotlist_names_level -Level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)@* -Type: integer (values: between 1 and 15), default value: 12@* -@item look_hotlist_names_length -Max length of names in hotlist (0 = no limit)@* -Type: integer (values: between 0 and 32), default value: 0@* -@item look_day_change -Display special message when day changes@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_day_change_timestamp -Timestamp for date displayed when day changed@* -Type: string (any string), default value: '%a, %d %b %Y'@* -@item look_read_marker -Use a marker on servers/channels to show first unread line@* -Type: string (any string), default value: ' '@* -@item col_real_white -If set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item col_title -Color for title bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_title_bg -Background for title bar@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_chat -Color for chat text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time -Color for time in chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time_sep -Color for time separator (chat window)@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_prefix1 -Color for 1st and 3rd char of prefix@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_prefix2 -Color for middle char of prefix@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_server -Color for server name@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_join -Color for join arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_chat_part -Color for part/quit arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_chat_nick -Color for nicks in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_host -Color for hostnames (chat window)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_chat_channel -Color for channel names in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_dark -Color for dark separators (chat window)@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_chat_highlight -Color for highlighted nick (chat window)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_bg -Background for chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_read_marker -Color for unread data marker@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_read_marker_bg -Background for unread data marker@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_status -Color for status bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_delimiters -Color for status bar delimiters@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_status_channel -Color for current channel in status bar@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_data_msg -Color for window with new messages (status bar)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_status_private -Color for window with private message (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_status_highlight -Color for window with highlight (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_status_data_other -Color for window with new data (not messages) (status bar)@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_more -Color for window with new data (status bar)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_bg -Background for status window@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar -Color for info bar text@* -Type: color (Curses or Gtk color), default value: 'black'@* -@item col_infobar_delimiters -Color for infobar delimiters@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar_highlight -Color for info bar highlight notification@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_infobar_bg -Background for info bar window@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input -Color for input text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_input_channel -Color for input text (channel name)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_input_nick -Color for input text (nick name)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_input_delimiters -Color for input text (delimiters)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input_bg -Background for input window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick -Color for nicknames@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_away -Color for away nicknames@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_chanowner -Color for chan owner symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_chanadmin -Color for chan admin symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_op -Color for operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_halfop -Color for half-operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_voice -Color for voice symbol@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_nick_more -Color for '+' when scrolling nicks@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_sep -Color for nick separator@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_self -Color for local nick@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_nick_color1 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_color2 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_nick_color3 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_nick_color4 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_nick_color5 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightblue'@* -@item col_nick_color6 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_color7 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_nick_color8 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_color9 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_color10 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_private -Color for other nick in private window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@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: 'lightcyan'@* -@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 history_display_default -Maximum number of commands to display by default in history listing (0 = unlimited)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item log_auto_server -Automatically log server messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_channel -Automatically log channel chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_private -Automatically log private chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_plugin_msg -Log messages from plugins (scripts)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_path -Path for WeeChat log files@* -Type: string (any string), default value: '~/.weechat/logs/'@* -@item log_timestamp -Timestamp for log (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Hide password displayed by nickserv@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_display_away -Display message to all channels when (un)marking as away@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_default_msg_away -Default message when away@* -Type: string (any string), default value: 'away'@* -@item irc_default_msg_part -Default part message (leaving channel)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_default_msg_quit -Default quit message ('%v' will be replaced by WeeChat version in string)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_notice_as_pv -Display notices as private messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_away_check -Interval between two checks for away (in minutes, 0 = never check)@* -Type: integer (values: between 0 and 2147483647), default value: 0@* -@item irc_lag_check -Interval between two checks for lag (in seconds)@* -Type: integer (values: between 30 and 2147483647), default value: 60@* -@item irc_lag_min_show -Minimum lag to show (in seconds)@* -Type: integer (values: between 0 and 2147483647), default value: 1@* -@item irc_lag_disconnect -Disconnect after important lag (in minutes, 0 = never disconnect)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item irc_fifo_pipe -Create a FIFO pipe for remote control@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_highlight -Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)@* -Type: string (any string), default value: ''@* -@item irc_colors_receive -When off, colors codes are ignored in incoming messages@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_colors_send -Allow user to send colors with special codes (%B=bold, %Cxx,yy=color, %U=underline, %R=reverse)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_accept_files -Automatically accept incoming dcc files@* -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: 'off'@* -@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: 65536)@* -Type: integer (values: between 1024 and 102400), default value: 65536@* -@item dcc_port_range -Restricts outgoing dcc to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port)@* -Type: string (any string), default value: ''@* -@item dcc_own_ip -IP or DNS address used for outgoing dcc (if empty, local interface IP is used)@* -Type: string (any string), default value: ''@* -@item dcc_download_path -Path for writing incoming files with dcc (default: user home)@* -Type: string (any string), default value: '~'@* -@item dcc_upload_path -Path for reading files when sending thru dcc (when no path is specified)@* -Type: string (any string), default value: '~'@* -@item dcc_convert_spaces -Convert spaces to underscores when sending files@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_rename -Rename incoming files if already exists (add '.1', '.2', ...)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_resume -Automatically resume dcc transfer if connection with remote host is loosed@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item proxy_use -Use a proxy server to connect to irc server@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_type -Proxy type (http (default), socks4, socks5)@* -Type: string (values: 'http', 'socks4', 'socks5'), default value: 'http'@* -@item proxy_ipv6 -Connect to proxy in ipv6@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_address -Proxy server address (IP or hostname)@* -Type: string (any string), default value: ''@* -@item proxy_port -Port for connecting to proxy server@* -Type: integer (values: between 0 and 65535), default value: 3128@* -@item proxy_username -Username for proxy server@* -Type: string (any string), default value: ''@* -@item proxy_password -Password for proxy server@* -Type: string (any string), default value: ''@* -@item plugins_path -Path for searching plugins@* -Type: string (any string), default value: '~/.weechat/plugins'@* -@item plugins_autoload -Comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "libperl.so")@* -Type: string (any string), default value: '*'@* -@item plugins_extension -Standard plugins extension in filename, used for autoload (if empty, then all files are loaded when autoload is "*")@* -Type: string (any string), default value: '.so'@* -@item server_name -Name associated to IRC server (for display only)@* -Type: string (any string), default value: ''@* -@item server_autoconnect -Automatically connect to server when WeeChat is starting@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect -Automatically reconnect to server when disconnected@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect_delay -Delay (in seconds) before trying again to reconnect to server@* -Type: integer (values: between 0 and 65535), default value: 30@* -@item server_address -IP address or hostname of IRC server@* -Type: string (any string), default value: ''@* -@item server_port -Port for connecting to server@* -Type: integer (values: between 0 and 65535), default value: 6667@* -@item server_ipv6 -Use IPv6 protocol for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_ssl -Use SSL for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_password -Password for IRC server@* -Type: string (any string), default value: ''@* -@item server_nick1 -Nickname to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_nick2 -Alternate nickname to use on IRC server (if nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_nick3 -2nd alternate nickname to use on IRC server (if alternate nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_username -User name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_realname -Real name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_command -First command to run when connected to server@* -Type: string (any string), default value: ''@* -@item server_command_delay -Delay (in seconds) after command was executed (example: give some time for authentication)@* -Type: integer (values: between 0 and 5), default value: 0@* -@item server_autojoin -Comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")@* -Type: string (any string), default value: ''@* -@item server_autorejoin -Automatically rejoin channels when kicked@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_notify_levels -Comma separated list of notify levels for channels of this server (format: #channel:1,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_iso -Comma separated list of charsets for server and channels, to decode ISO (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_utf -Comma separated list of charsets for server and channels, to decode UTF (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_encode -Comma separated list of charsets for server and channels, to encode messages (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@end table - -Colors for Curses GUI are:@* -@itemize @minus -@item -@kbd{default}: default color (transparent for background) -@item -@kbd{black}: black -@item -@kbd{red}: dark red -@item -@kbd{lightred}: light red -@item -@kbd{green}: dark green -@item -@kbd{lightgreen}: light green -@item -@kbd{brown}: brown -@item -@kbd{yellow}: yellow -@item -@kbd{blue}: dark blue -@item -@kbd{lightblue}: light blue -@item -@kbd{magenta}: dark magenta -@item -@kbd{lightmagenta}: light magenta -@item -@kbd{cyan}: dark cyan -@item -@kbd{lightcyan}: light cyan -@item -@kbd{white}: white -@end itemize - -@node Recursos de teclado, Comandos do WeeChat, Config file, Utilizacao -@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 / Ctrl + A -Ir para o in@'icio da linha de comando@* -@* -@item End / Ctrl + E -Ir para o fim da linha de comando@* -@* -@item Ctrl + K -Delete until end of line@* -@* -@item Ctrl + L -Redesenhe a janela inteira@* -@* -@item Ctrl + U -Delete until beginning of line@* -@* -@item Ctrl + W -Apagar a palavra anterior na linha de comando -@* -@item Backspace / Delete -Apagar o caractere anterior / seguinte 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 Ctrl + up arrow / Ctrl + down arrow -Call again last commands/messages in global history@* -@* -@item PageUp / PageDown -Navegar no hist@'orico da janela@* -@* -@item F5 / F6 -Comute ao amortecedor anterior / seguinte@* -@* -@item F7 / F8 -Comute ao janela anterior / seguinte@* -@* -@item F10 -Apagar a @'ultima mensagem da barra do info@* -@* -@item F11 / F12 -Scroll nicklist@* -@* -@item Alt + Seta da esquerda / Alt + Seta da direita -Identico a F5 / F6@* -@* -@item Alt + A -Comute ao amortecedor seguinte com atividade (com prioridade: destaque, mensagem, outra)@* -@* -@item Alt + B -Go to previous word@* -@* -@item Alt + D -Delete next word@* -@* -@item Alt + F -Go to next word@* -@* -@item Alt + H -Hotlist desobstru@'ido (notifica@,{c}@~ao da atividade em outros amortecedores)@* -@* -@item Alt + J then Alt + D -Exposi@,{c}@~ao DCC atual@* -@* -@item Alt + J then Alt + L -Switch to last buffer@* -@* -@item Alt + J then Alt + S -Comute ao amortecedor do servidor@* -@* -@item Alt + J then Alt + X -Comute @`a primeira canaleta do servidor seguinte (ou do amortecedor do servidor se nenhuma canaleta for aberta)@* -@* -@item Alt + d@'igito (1-9) -Comute ao amortecedor pelo n@'umero@* -@* -@item Alt + J then number (01-99) -Comute ao amortecedor pelo n@'umero@* -@* -@item Alt + K -Grab a key -@* -@item Alt + N -Scroll to next highlight@* -@* -@item Alt + P -Scroll to previous highlight@* -@* -@item Alt + R -Delete entire line@* -@* -@item Alt + S -Switch server on servers buffer@* -(if option ``look_one_server_buffer'' is enabled)@* -@* -@item Alt + U -Scroll to first unread line in buffer@* -@* -@item Alt + W then Alt + arrow -Switch to window with direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Scroll nicklist@* -@* -@end table - -@node Comandos do WeeChat, FIFO pipe, Recursos de teclado, Utilizacao -@section Comandos do WeeChat - -WeeChat internal commands:@* - -@table @kbd -@item alias [alias_name [command [arguments]] -@* -create an alias for a command@* -@* -alias_name: name of alias@* -command: command name (WeeChat or IRC command, without first '/')@* -arguments: arguments for command@* -@* -@item buffer [action | number | [[server] [channel]]] -@* -manage buffers@* -@* -action: action to do:@* - move: move buffer in the list (may be relative, for example -1)@* - close: close buffer (for channel: same as /part without part message)@* - list: list opened buffers (no parameter implies this list)@* - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)@* -server,channel: jump to buffer by server and/or channel name@* -number: jump to buffer by number@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -change charset for server or channel@* -@* -decode_iso: charset used for decoding ISO@* -decode_utf: charset used for decoding UTF@* - encode: charset used for encoding messages@* - charset: charset to use (for example: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -clear window(s)@* -@* --all: clear all windows@* -@* -@item connect [servername] -@* -connect to a server@* -@* -servername: server name to connect@* -@* -@item disconnect [servername] -@* -disconnect from a server@* -@* -servername: server name to disconnect@* -@* -@item debug dump | windows -@* -print debug messages@* -@* -dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)@* -windows: display windows tree@* -@* -@item help [command] -@* -display help about commands@* -@* -command: name of a WeeChat or IRC command@* -@* -@item history [clear | value] -@* -show buffer command history@* -@* -clear: clear history@* -value: number of history entries to show@* -@* -@item ignore [mask [[type | command] [channel [server]]]] -@* -ignore IRC messages and/or hosts@* -@* - mask: nick or host mask to ignore@* - type: type of message to ignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for ignore@* - server: name of server for ignore@* -@* -For each argument, '*' means all.@* -Without argument, /ignore command lists all defined ignore.@* -@* -@item key [key function/command] [unbind key] [functions] [reset -yes] -@* -bind/unbind keys@* -@* -key: bind this key to an internal function or a command (beginning by "/")@* -unbind: unbind a key (if "all", default bindings are restored)@* -functions: list internal functions for key bindings@* -reset: restore bindings to the default values and delete ALL personal binding (use carefully!)@* -@* -@item plugin [load filename] | [autoload] | [reload] | [unload] -@* -list/load/unload plugins@* -@* -filename: WeeChat plugin (file) to load@* -@* -Without argument, /plugin command lists all loaded plugins.@* -@* -@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] -@* -list, add or remove servers@* -@* -servername: server name, for internal & display use@* -hostname: name or IP address of server@* -port: port for server (integer)@* -ipv6: use IPv6 protocol@* -ssl: use SSL protocol@* -password: password for server@* -nick1: first nick for server@* -nick2: alternate nick for server@* -nick3: second alternate nick for server@* -username: user name@* -realname: real name of user@* -@* -@item save [file] -@* -save config to disk@* -@* -file: filename for writing config@* -@* -@item set [option [ = value]] -@* -set config parameters@* -@* -option: name of an option (if name is full and no value is given, then help is displayed on option)@* -value: value for option@* -@* -@item unalias alias_name -@* -remove an alias@* -@* -alias_name: name of alias to remove@* -@* -@item unignore [number | [mask [[type | command] [channel [server]]]]] -@* -unignore IRC messages and/or hosts@* -@* - number: # of ignore to unignore (number is displayed by list of ignore)@* - mask: nick or host mask to unignore@* - type: type of message to unignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for unignore@* - server: name of server for unignore@* -@* -For each argument, '*' means all.@* -Without argument, /unignore command lists all defined ignore.@* -@* -@item upgrade -@* -upgrade WeeChat without disconnecting from servers@* -@* -@item uptime [-o] -@* -show WeeChat uptime@* -@* --o: send uptime on current channel as an IRC message@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]] -@* -manage windows@* -@* -list: list opened windows (no parameter implies this list)@* --1: jump to previous window@* -+1: jump to next window@* -b#: jump to next window displaying buffer number #@* -up: switch to window above current one@* -down: switch to window below current one@* -left: switch to window on the left@* -right: switch to window on the right@* -splith: split current window horizontally@* -splitv: split current window vertically@* -resize: resize window size, new size is <pct>%% of parent window@* -merge: merge window with another (all = keep only one window)@* -@* -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4@* -@* -@end table - -IRC commands:@* - -@table @kbd -@item admin [target] -@* -find information about the administrator of the server@* -@* -target: server@* -@* -@item ame message -@* -send a CTCP action to all channels of all connected servers@* -@* -message: message to send@* -@* -@item amsg text -@* -send message to all channels of all connected servers@* -@* -text: text to send@* -@* -@item away [-all] [message] -@* -toggle away status@* -@* --all: toggle away status on all connected servers@* -message: message for away (if no message is given, away status is removed)@* -@* -@item ban [channel] [nickname [nickname ...]] -@* -bans nicks or hosts@* -@* -channel: channel for ban@* -nickname: user or host to ban@* -@* -@item ctcp nickname type [arguments] -@* -send a CTCP message (Client-To-Client Protocol)@* -@* -nickname: user to send CTCP to@* -type: CTCP type (examples: "version", "ping", ..)@* -arguments: arguments for CTCP@* -@* -@item dcc action [nickname [file]] -@* -starts DCC (file or chat) or close chat@* -@* -action: 'send' (file) or 'chat' or 'close' (chat)@* -nickname: nickname to send file or chat@* -file: filename (on local host)@* -@* -@item dehalfop [nickname [nickname]] -@* -removes half channel operator status from nickname(s)@* -@* -@item deop [nickname [nickname]] -@* -removes channel operator status from nickname(s)@* -@* -@item devoice [nickname [nickname]] -@* -removes voice from nickname(s)@* -@* -@item die -@* -shutdown the server@* -@* -@item halfop [nickname [nickname]] -@* -gives half channel operator status to nickname(s)@* -@* -@item info [target] -@* -get information describing the server@* -@* -target: server name@* -@* -@item invite nickname channel -@* -invite a nick on a channel@* -@* -nickname: nick to invite@* -channel: channel to invite@* -@* -@item ison nickname [nickname ...] -@* -check if a nickname is currently on IRC@* -@* -nickname: nickname@* -@* -@item join channel[,channel] [key[,key]] -@* -join a channel@* -@* -channel: channel name to join@* -key: key to join the channel@* -@* -@item kick [channel] nickname [comment] -@* -forcibly remove a user from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick@* -comment: comment for kick@* -@* -@item kickban [channel] nickname [comment] -@* -kicks and bans a nick from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick and ban@* -comment: comment for kick@* -@* -@item kill nickname comment -@* -close client-server connection@* -@* -nickname: nickname@* -comment: comment for kill@* -@* -@item links [[server] server_mask] -@* -list all servernames which are known by the server answering the query@* -@* -server: this server should answer the query@* -server_mask: list of servers must match this mask@* -@* -@item list [channel[,channel] [server]] -@* -list channels and their topic@* -@* -channel: channel to list@* -server: server name@* -@* -@item lusers [mask [target]] -@* -get statistics about the size of the IRC network@* -@* -mask: servers matching the mask only@* -target: server for forwarding request@* -@* -@item me message -@* -send a CTCP action to the current channel@* -@* -message: message to send@* -@* -@item mode @{ channel @{[+|-]|o|p|s|i|t|n|b|v@} [limit] [user] [ban mask] @} | @{ nickname @{[+|-]|i|w|s|o@} @} -@* -change channel or user mode@* -@* -channel modes:@* - channel: channel name to modify@* - o: give/take channel operator privileges@* - p: private channel flag@* - s: secret channel flag@* - i: invite-only channel flag@* - t: topic settable by channel operator only flag@* - n: no messages to channel from clients on the outside@* - m: moderated channel@* - l: set the user limit to channel@* - b: set a ban mask to keep users out@* - e: set exception mask@* - v: give/take the ability to speak on a moderated channel@* - k: set a channel key (password)@* -user modes:@* - nickname: nickname to modify@* - i: mark a user as invisible@* - s: mark a user for receive server notices@* - w: user receives wallops@* - o: operator flag@* -@* -@item motd [target] -@* -get the "Message Of The Day"@* -@* -target: server name@* -@* -@item msg receiver[,receiver] text -@* -send message to a nick or channel@* -@* -receiver: nick or channel (may be mask, '*' = current channel)@* -text: text to send@* -@* -@item names [channel[,channel]] -@* -list nicknames on channels@* -@* -channel: channel name@* -@* -@item nick [-all] nickname -@* -change current nickname@* -@* --all: set new nickname for all connected servers@* -nickname: new nickname@* -@* -@item notice nickname text -@* -send notice message to user@* -@* -nickname: user to send notice to@* -text: text to send@* -@* -@item op nickname [nickname] -@* -gives channel operator status to nickname(s)@* -@* -@item oper user password -@* -get operator privileges@* -@* -user/password: used to get privileges on current IRC server@* -@* -@item part [channel[,channel]] [part_message] -@* -leave a channel@* -@* -channel: channel name to leave@* -part_message: part message (displayed to other users)@* -@* -@item ping server1 [server2] -@* -ping server@* -@* -server1: server to ping@* -server2: forward ping to this server@* -@* -@item pong daemon [daemon2] -@* -answer to a ping message@* -@* -daemon: daemon who has responded to Ping message@* -daemon2: forward message to this daemon@* -@* -@item query nickname [text] -@* -send a private message to a nick@* -@* -nickname: nickname for private conversation@* -text: text to send@* -@* -@item quit [quit_message] -@* -close all connections & quit@* -@* -quit_message: quit message (displayed to other users)@* -@* -@item quote data -@* -send raw data to server without parsing@* -@* -data: raw data to send@* -@* -@item rehash -@* -tell the server to reload its config file@* -@* -@item restart -@* -tell the server to restart itself@* -@* -@item service nickname reserved distribution type reserved info -@* -register a new service@* -@* -distribution: visibility of service@* -type: reserved for future usage@* -@* -@item servlist [mask [type]] -@* -list services currently connected to the network@* -@* -mask: list only services matching this mask@* -type: list only services of this type@* -@* -@item squery service text -@* -deliver a message to a service@* -@* -service: name of service@* -text: text to send@* -@* -@item squit server comment -@* -disconnect server links@* -@* -server: server name@* -comment: comment for quit@* -@* -@item stats [query [server]] -@* -query statistics about server@* -@* -query: c/h/i/k/l/m/o/y/u (see RFC1459)@* -server: server name@* -@* -@item summon user [target [channel]] -@* -give users who are on a host running an IRC server a message asking them to please join IRC@* -@* -user: username@* -target: server name@* -channel: channel name@* -@* -@item time [target] -@* -query local time from server@* -@* -target: query time from specified server@* -@* -@item topic [channel] [topic] -@* -get/set channel topic@* -@* -channel: channel name@* -topic: new topic for channel (if topic is "-delete" then topic is deleted)@* -@* -@item trace [target] -@* -find the route to specific server@* -@* -target: server@* -@* -@item unban [channel] nickname [nickname ...] -@* -unbans nicks or hosts@* -@* -channel: channel for unban@* -nickname: user or host to unban@* -@* -@item userhost nickname [nickname ...] -@* -return a list of information about nicknames@* -@* -nickname: nickname@* -@* -@item users [target] -@* -list of users logged into the server@* -@* -target: server@* -@* -@item version [server | nickname] -@* -gives the version info of nick or server (current or specified)@* -@* -server: server name@* -nickname: nickname@* -@* -@item voice [nickname [nickname]] -@* -gives voice to nickname(s)@* -@* -@item wallops text -@* -send a message to all currently connected users who have set the 'w' user mode for themselves@* -@* -text to send@* -@* -@item who [mask ["o"]] -@* -generate a query which returns a list of information@* -@* -mask: only information which match this mask@* -o: only operators are returned according to the mask supplied@* -@* -@item whois [server] nickname[,nickname] -@* -query information about user(s)@* -@* -server: server name@* -nickname: nickname (may be a mask)@* -@* -@item whowas nickname [,nickname [,nickname ...]] [count [target]] -@* -ask for information about a nickname which no longer exists@* -@* -nickname: nickname to search@* -count: number of replies to return (full search if negative number)@* -target: reply should match this mask@* -@* -@end table - -Internal functions for keys:@* - -@table @kbd -@item return -terminate line@* -@item tab -complete word@* -@item backspace -delete previous char@* -@item delete -delete next char@* -@item delete_end_line -delete until end of line@* -@item delete_beginning_line -delete until beginning of line@* -@item delete_line -delete entire line@* -@item delete_previous_word -delete previous word@* -@item delete_next_word -delete next word@* -@item clipboard_paste -paste current clipboard content@* -@item transpose_chars -transpose chars@* -@item home -go to beginning of line@* -@item end -go to end of line@* -@item left -move one char left@* -@item previous_word -move to previous word@* -@item right -move one char right@* -@item next_word -move to next word@* -@item up -call previous command in history@* -@item up_global -call previous command in global history@* -@item down -call next command in history@* -@item down_global -call next command in global history@* -@item page_up -scroll one page up@* -@item page_down -scroll one page down@* -@item nick_beginning -display beginning of nicklist@* -@item nick_end -display end of nicklist@* -@item nick_page_up -scroll nicklist one page up@* -@item nick_page_down -scroll nicklist one page down@* -@item jump_smart -jump to buffer with activity@* -@item jump_dcc -jump to DCC buffer@* -@item jump_last_buffer -jump to last buffer@* -@item jump_server -jump to server buffer@* -@item jump_next_server -jump to next server@* -@item switch_server -switch active server on servers buffer@* -@item scroll_previous_highlight -scroll to previous highlight in buffer@* -@item scroll_next_highlight -scroll to next highlight in buffer@* -@item scroll_unread -scroll to first unread line in buffer@* -@item hotlist_clear -clear hotlist@* -@item infobar_clear -clear infobar@* -@item refresh -refresh screen@* -@item grab_key -grab a key@* -@end table - -@node FIFO pipe, , Comandos do WeeChat, Utilizacao -@section FIFO pipe - -You can remote control WeeChat, by sending commands or text to a FIFO pipe -(you have to enable option "irc_fifo_pipe", it is disabled by default).@* -The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" -(where xxxxx is the process ID (PID) of running WeeChat).@* -So if many WeeChat are running, you have many FIFO pipe, one for each session.@* -@* -The syntax for the FIFO pipe commands/text is:@* -@command{server,channel *text or command here}@* -where server and channel are optional, but if channel is here, server should be too.@* -@* -Some examples: -@table @asis -@item @bullet{} change your nick on freenode to "mynick|out": -@* -@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on #weechat channel: -@* -@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on current channel (buffer displayed by WeeChat): -@* -@command{echo "*hello!" >~/.weechat/weechat_fifo_12345} -@* -@b{Warning:} this is dangerous and you should not do that except if you know what you do! -@* -@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -You can write a script to send command to all running WeeChat at same time, for example:@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -If the script is called "auto_weechat_command", you can run it with:@* -@command{./auto_weechat_command "freenode,#weechat *hello"} - - -@c ********************************* Plugins ********************************** - -@node Plugins, Autores/Suporte, Utilizacao, Top -@chapter Plugins - -@menu -* Plugins in WeeChat:: -* Write a plugin:: -* Plugin example:: -* Scripts plugins:: -@end menu - -@node Plugins in WeeChat, Write a plugin, Plugins, Plugins -@section Plugins in WeeChat - -A plugin is a C program which can call WeeChat functions defined in an -interface.@* -@* -This C program does not need WeeChat sources to compile and can be -dynamically loaded into WeeChat with command @command{/plugin}.@* -@* -The plugin has to be a dynamic library, for dynamic loading by -operating system. -Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under -Windows. - -@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins -@section Write a plugin - -@subsection Base rules - -The plugin should include ``weechat-plugin.h'' file (available in -WeeChat source code).@* -This file defines structures and types used to communicate with WeeChat.@* -@* -The plugin must have some variables and functions (mandatory, without -them the plugin can't load):@* -@itemize @bullet -@item variables for plugin description: -@itemize @minus -@item plugin_name[]: plugin name -@item plugin_version[]: plugin version -@item plugin_description[]: short description of plugin -@end itemize -@item functions for init and end of plugin: -@itemize @minus -@item weechat_plugin_init: function called when plugin is loaded, -must return PLUGIN_RC_OK (0) if successful, PLUGIN_RC_KO (-1) if error -@item weechat_plugin_end: function called when plugin is unloaded -@end itemize -@end itemize - -@subsection API functions - -The plugin can call some functions defined in t_weechat_plugin -structure.@* -@* -These functions are detailed below:@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Locale and case independent string comparison.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Locale and case independent string comparison, for ``max'' chars.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@item @option{max}: max number of chars for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explode a string according to one or more delimiter(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string to explode -@item @option{separators}: delimiters used for explosion -@item @option{num_items_max}: maximum number of items created (0 means -no limit) -@item @option{num_items}: pointer to int which will contain number of -items created -@end itemize -@* -@emph{Return value:}@* -@* -Array of strings, NULL if problem.@* -Note: the result has to be free by a call to ``free_exploded_string'' -function after use.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Free memory used by a string explosion.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string exploded by ``explode_string'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Execute a function on all files of a directory.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{directory}: directory for searching files -@item @option{callback}: function called for each file found -@end itemize -@* -@emph{Return value:}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "file: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Display a message on a WeeChat buffer, identified by server and -channel (both may be NULL for current buffer).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server to find buffer for message -display (may be NULL) -@item @option{channel}: name of channel to find buffer for message -display (may be NULL) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Display a message on server buffer.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Display a message in infobar for a specified time.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{time}: time in seconds for displaying message (0 means -never erased) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Add an IRC message handler, called when an IRC message is received.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: IRC message (for example: ``PRIVMSG'') -@item @option{handler_func}: function called when message is received -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new message handler.@* -@* -@emph{Example:}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK received");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to -WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to -other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Add a WeeChat command handler, called when user uses command -(for example /command).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{command}: the new command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers name -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@item @option{handler_func}: function called when comand is executed -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new command handler.@* -@* -@emph{Example:}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "test command, -file: %s", (arguments) ? arguments : "none");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Test command", -"[file]", "file: a file name", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Remove a command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{handler}: handler to remove -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Remove all handlers for a plugin.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute a WeeChat command (or send a message to a channel).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server for executing command (may be -NULL) -@item @option{channel}: name of channel for executing command (may be -NULL) -@item @option{command}: command -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Return an info about WeeChat or a channel.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{info}: name of info to read: -@itemize @minus -@item @option{version}: get WeeChat's version -@item @option{nick}: get nick -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir -@end itemize -@item @option{server}: name of server for reading info (if needed) -@end itemize -@* -@emph{Return value:}@* -@* -Information asked, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Returns list of DCC currently active or finished.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -Chained list of DCC.@* -Note: result has to be free by a call to ``free_dcc_info'' function -after use.@* -@* -@emph{Example:}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, with: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Free memory used by a DCC list.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{dcc_info}: pointer to DCC list returned by -``get_dcc_info'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Example:}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "my_var");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_plugin_config (plugin, "my_var", "value");}@* -@* - -@end itemize - -@subsection Compile plugin - -Compile does not need WeeChat sources, only file -``weechat-plugin.h''.@* - -To compile a plugin which has one file ``toto.c'' (sous GNU/Linux):@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Load plugin under WeeChat - -Copy ``libtoto.so'' file into general plugins dir (for example -/usr/local/lib/weechat/plugins) or into user's plugins dir (for -example /home/xxxxx/.weechat/plugins).@* -@* -Under WeeChat:@* -@command{/plugin load toto} - -@node Plugin example, Scripts plugins, Write a plugin, Plugins -@section Plugin example - -Full example of plugin, which adds a /double command, which displays -two times arguments on current channel (ok that's not very useful, but -that's just an example!):@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/hello" command handler */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -@end verbatim - -@node Scripts plugins, , Plugin example, Plugins -@section Scripts plugins - -Three plugins are provided with WeeChat to load scripts: Perl, -Python and Ruby. - -@subsection Load/unload scripts - -Perl scripts are loaded and unloaded with @command{/perl}, -@command{/python} and @command{/ruby} commands. -(type @kbd{/help} within WeeChat to get help about commands).@* - -@emph{Examples:}@* -@itemize @bullet -@item -Load a Perl script: @kbd{/perl load /tmp/sample.pl}@* -@item -Unload all Perl scripts: @kbd{/perl unload}@* -@item -List all Perl scripts: @kbd{/perl}@* -@item -Load a Python script: @kbd{/python load /tmp/sample.py}@* -@item -Unload all Python scripts: @kbd{/python unload}@* -@item -List all Python scripts: @kbd{/python}@* -@end itemize - -@subsection WeeChat / Scripts API - -@itemize @bullet -@item -Perl: @command{weechat::register ( name, version, shutdown_function, -description );}@* -Python: @command{weechat.register ( name, version, shutdown_function, -description )}@* -@* -This is first function to call in script.@* -All 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}: 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{Return value:}@* -@* -1 if script was registered, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::register ("sample", "1.0", "sample_end", "Sample -script!");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.register ("sample", "1.0", "sample_end", "Sample -script!")}@* -@* - -@item -Perl: @command{weechat::print ( message, [channel, [server]] );}@* -Python: @command{weechat.prnt ( message, [channel, [server]] )}@* -@* -Print message in a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{message}: message to display -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( delay, message );}@* -Python: @command{weechat.print_infobar ( delay, message )}@* -@* -Print message in infobar.@* - -@emph{Arguments:} -@itemize @minus -@item @option{delay}: after this delay (in seconds), message will be erased -(if 0, message will not be erased). -@item @option{message}: message to display -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( name, function );}@* -Python: @command{weechat.add_message_handler ( name, function )}@* -@* -Attach a script 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}: function called when message is received -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_message_handler ("privmsg", my_function);}@* -@code{sub my_function}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("server=$_[0]\n");}@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* -@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_message_handler ("privmsg", my_function)}@* -@code{def my_function(server, args):}@* -@code{@ @ @ @ weechat.prnt("server="+server)}@* -@code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent -to WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent -to other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Create new WeeChat command, linked with script 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 -script function. Be careful when overriding WeeChat commands, they'll not be -available until your script will be unloaded. -@item @option{function}: function linked with command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_command_handler ("command", my_command);}@* -@code{sub my_command}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_command_handler ("command", my_command)}@* -@code{def my_command(server, args):}@* -@code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( name, function );}@* -Python: @command{weechat.remove_handler ( name, function )}@* -@* -Remove a message or command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of IRC message or command handler -@item @option{function}: function -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::remove_handler ("command", my_command);}@* -@* -@emph{Python example:}@* -@* -@code{weechat.remove_handler ("command", my_command)}@* -@* - -@item -Perl: @command{weechat::command ( command, [channel, [server]] );}@* -Python: @command{weechat.command ( command, [channel, [server]] )}@* -@* -Execute a command or send a message to a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{command}: command to execute (or message to send in a channel) -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::command ("hello world!");}@* -@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.command ("hello world!")}@* -@code{weechat.command ("/kick toto please leave this chan", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( name, [server] );}@* -Python: @command{weechat.get_info ( name, [server] )}@* -@* -Get various info about WeeChat, server or user.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of info to retrieve: -@itemize @minus -@item @option{version}: get WeeChat version -@item @option{nick}: get nickname -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir - -@end itemize -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -Asked info, empty if error occured or info was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$version = weechat::get_info("version");}@* -@code{$nick = weechat::get_info("nick", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{$version = weechat.get_info("version")}@* -@code{$nick = weechat.get_info("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( );}@* -@* -Get DCC list.@* - -Returned array has following fields: -@itemize @minus -@item server: IRC server -@item channel: IRC channel -@item type: DCC type: -@itemize @minus -@item 0: chat (received) -@item 1: chat (sent) -@item 2: file (receiving) -@item 3: file (sending) -@end itemize -@item status: DCC status: -@itemize @minus -@item 0: waiting -@item 1: connecting -@item 2: active -@item 3: done -@item 4: failed -@item 5: aborted -@end itemize -@item start_time: date/time of DCC creation -@item start_transfer: date/time of transfer start -@item addr: remote address -@item port: port used for DCC -@item nick: remote nick -@item filename: filename -@item local_filename: local filename -@item size: file size -@item pos: current position in file -@item start_resume: restart position after interruption -@item bytes_per_sec: bytes sent/received per second -@end itemize -@* -@emph{Return value:}@* -@* -DCC list, 0 if error occured.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Python examples:}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, value );}@* -Python: @command{weechat.set_config ( option, value )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin"", -"#weechat");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl example:}@* -@* -@code{$value = weechat::get_plugin_config ("my_var");}@* -@* -@emph{Python example:}@* -@* -@code{$value = weechat.get_plugin_config ("my_var")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, value );}@* -Python: @command{weechat.set_plugin_config ( option, value )}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::set_plugin_config ("my_var", "value");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.set_plugin_config ("my_var", "value")}@* -@* - -@end itemize - - -@c **************************** Autores/Suporte ***************************** - -@node Autores/Suporte, , Plugins, 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}> - -@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 : @uref{http://forums.flashtux.org}@*@* -@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{} 2005 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_doc_en.texi b/weechat/doc/weechat_doc_en.texi deleted file mode 100644 index 115c46c05..000000000 --- a/weechat/doc/weechat_doc_en.texi +++ /dev/null @@ -1,2914 +0,0 @@ -\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) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@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.1.7-cvs - December, 16 2005 - -@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}@* -@* -Copyright @copyright{} 2005 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 -* Plugins:: WeeChat plugins -* 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 (with SSL, IPv6, proxy) -@item -many GUI: Curses, wxWidgets, 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, MacOS X, 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{apt-get install weechat-curses} -@item -Mandriva/Redhat (or any RPM compatible distribution)@* -To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm} -@item -Gentoo@* -To install: @kbd{emerge weechat} -@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, Plugins, Installation, Top -@chapter Usage - -@menu -* Run WeeChat:: -* Config file:: -* Key bindings:: -* WeeChat commands:: -* FIFO pipe:: -@end menu - -@node Run WeeChat, Config file, Usage, Usage -@section Run WeeChat - -@subsection Command line parameters - -@table @code -@item -a, --no-connect -Disable auto-connect to servers at startup@* -@item -c, --config -Display config file help (list of options)@* -@item -f, --key-functions -Display WeeChat internal functions for keys@* -@item -h, --help -Display help screen@* -@item -i, --irc-commands -Display IRC commands list@* -@item -k, --keys -Display WeeChat default keys@* -@item -l, --license -Display WeeChat license@* -@item -p, --no-plugin -Don't load any plugin at startup -@item -v, --version -Display WeeChat version@* -@item -w, --weechat-commands -Display WeeChat commands list@* -@end table - -@subsection Run WeeChat - -Just issue this command to run WeeChat:@* -@kbd{weechat-curses} (for Curses front-end)@* -or @kbd{weechat-wxwidgets} (for wxWidgets front-end)@* -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 Config file, Key bindings, Run WeeChat, Usage -@section Config file - -List of options for config file:@* - -@table @kbd -@item look_set_title -Set title for window (terminal for Curses GUI) with name & version@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_logo -Display WeeChat logo at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_version -Display WeeChat version at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_weechat_slogan -WeeChat slogan (if empty, slogan is not used)@* -Type: string (any string), default value: 'the geekest IRC client!'@* -@item look_charset_decode_iso -ISO charset for decoding messages from server (used only if locale is UTF-8) (if empty, messages are not converted if locale is UTF-8@* -Type: string (any string), default value: 'ISO-8859-1'@* -@item look_charset_decode_utf -UTF charset for decoding messages from server (used only if locale is not UTF-8) (if empty, messages are not converted if locale is not UTF-8@* -Type: string (any string), default value: 'UTF-8'@* -@item look_charset_encode -Charset for encoding messages sent to server, examples: UFT-8, ISO-8859-1 (if empty, messages are not converted)@* -Type: string (any string), default value: ''@* -@item look_charset_internal -Forces internal WeeChat charset (should be empty in most cases, that means detected charset is used)@* -Type: string (any string), default value: ''@* -@item look_one_server_buffer -Use same buffer for all servers@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item look_buffer_timestamp -Timestamp for buffers@* -Type: string (any string), default value: '[%H:%M:%S]'@* -@item look_color_nicks_number -Number of colors to use for nicks colors@* -Type: integer (values: between 1 and 10), default value: 10@* -@item look_color_actions -Display actions with different colors@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist -Display nicklist window (for channel windows)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist_position -Nicklist position (top, left, right (default), bottom)@* -Type: string (values: 'left', 'right', 'top', 'bottom'), default value: 'right'@* -@item look_nicklist_min_size -Min size for nicklist (width or height, depending on look_nicklist_position (0 = no min size))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_nicklist_max_size -Max size for nicklist (width or height, depending on look_nicklist_position (0 = no max size; if min == max and > 0, then size is fixed))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_no_nickname -Text to display instead of nick when not connected@* -Type: string (any string), default value: '-cmd-'@* -@item look_nickmode -Display nick mode ((half)op/voice) before each nick@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nickmode_empty -Display space if nick mode is not (half)op/voice@* -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_nick_completion_ignore -Chars ignored for nick completion@* -Type: string (any string), default value: '[]-^'@* -@item look_infobar -Enable info bar@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_timestamp -Timestamp for time in infobar@* -Type: string (any string), default value: '%B, %A %d %Y'@* -@item look_infobar_seconds -Display seconds in infobar time@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_delay_highlight -Delay (in seconds) for highlight messages in infobar (0 = disable highlight notifications in infobar)@* -Type: integer (values: between 0 and 2147483647), default value: 7@* -@item look_hotlist_names_count -Max number of names in hotlist (0 = no name displayed, only buffer numbers)@* -Type: integer (values: between 0 and 32), default value: 3@* -@item look_hotlist_names_level -Level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)@* -Type: integer (values: between 1 and 15), default value: 12@* -@item look_hotlist_names_length -Max length of names in hotlist (0 = no limit)@* -Type: integer (values: between 0 and 32), default value: 0@* -@item look_day_change -Display special message when day changes@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_day_change_timestamp -Timestamp for date displayed when day changed@* -Type: string (any string), default value: '%a, %d %b %Y'@* -@item look_read_marker -Use a marker on servers/channels to show first unread line@* -Type: string (any string), default value: ' '@* -@item col_real_white -If set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item col_title -Color for title bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_title_bg -Background for title bar@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_chat -Color for chat text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time -Color for time in chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time_sep -Color for time separator (chat window)@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_prefix1 -Color for 1st and 3rd char of prefix@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_prefix2 -Color for middle char of prefix@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_server -Color for server name@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_join -Color for join arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_chat_part -Color for part/quit arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_chat_nick -Color for nicks in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_host -Color for hostnames (chat window)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_chat_channel -Color for channel names in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_dark -Color for dark separators (chat window)@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_chat_highlight -Color for highlighted nick (chat window)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_bg -Background for chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_read_marker -Color for unread data marker@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_read_marker_bg -Background for unread data marker@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_status -Color for status bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_delimiters -Color for status bar delimiters@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_status_channel -Color for current channel in status bar@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_data_msg -Color for window with new messages (status bar)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_status_private -Color for window with private message (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_status_highlight -Color for window with highlight (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_status_data_other -Color for window with new data (not messages) (status bar)@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_more -Color for window with new data (status bar)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_bg -Background for status window@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar -Color for info bar text@* -Type: color (Curses or Gtk color), default value: 'black'@* -@item col_infobar_delimiters -Color for infobar delimiters@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar_highlight -Color for info bar highlight notification@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_infobar_bg -Background for info bar window@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input -Color for input text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_input_channel -Color for input text (channel name)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_input_nick -Color for input text (nick name)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_input_delimiters -Color for input text (delimiters)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input_bg -Background for input window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick -Color for nicknames@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_away -Color for away nicknames@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_chanowner -Color for chan owner symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_chanadmin -Color for chan admin symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_op -Color for operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_halfop -Color for half-operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_voice -Color for voice symbol@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_nick_more -Color for '+' when scrolling nicks@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_sep -Color for nick separator@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_self -Color for local nick@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_nick_color1 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_color2 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_nick_color3 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_nick_color4 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_nick_color5 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightblue'@* -@item col_nick_color6 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_color7 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_nick_color8 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_color9 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_color10 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_private -Color for other nick in private window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@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: 'lightcyan'@* -@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 history_display_default -Maximum number of commands to display by default in history listing (0 = unlimited)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item log_auto_server -Automatically log server messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_channel -Automatically log channel chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_private -Automatically log private chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_plugin_msg -Log messages from plugins (scripts)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_path -Path for WeeChat log files@* -Type: string (any string), default value: '~/.weechat/logs/'@* -@item log_timestamp -Timestamp for log (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Hide password displayed by nickserv@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_display_away -Display message to all channels when (un)marking as away@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_default_msg_away -Default message when away@* -Type: string (any string), default value: 'away'@* -@item irc_default_msg_part -Default part message (leaving channel)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_default_msg_quit -Default quit message ('%v' will be replaced by WeeChat version in string)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_notice_as_pv -Display notices as private messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_away_check -Interval between two checks for away (in minutes, 0 = never check)@* -Type: integer (values: between 0 and 2147483647), default value: 0@* -@item irc_lag_check -Interval between two checks for lag (in seconds)@* -Type: integer (values: between 30 and 2147483647), default value: 60@* -@item irc_lag_min_show -Minimum lag to show (in seconds)@* -Type: integer (values: between 0 and 2147483647), default value: 1@* -@item irc_lag_disconnect -Disconnect after important lag (in minutes, 0 = never disconnect)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item irc_fifo_pipe -Create a FIFO pipe for remote control@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_highlight -Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)@* -Type: string (any string), default value: ''@* -@item irc_colors_receive -When off, colors codes are ignored in incoming messages@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_colors_send -Allow user to send colors with special codes (%B=bold, %Cxx,yy=color, %U=underline, %R=reverse)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_accept_files -Automatically accept incoming dcc files@* -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: 'off'@* -@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: 65536)@* -Type: integer (values: between 1024 and 102400), default value: 65536@* -@item dcc_port_range -Restricts outgoing dcc to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port)@* -Type: string (any string), default value: ''@* -@item dcc_own_ip -IP or DNS address used for outgoing dcc (if empty, local interface IP is used)@* -Type: string (any string), default value: ''@* -@item dcc_download_path -Path for writing incoming files with dcc (default: user home)@* -Type: string (any string), default value: '~'@* -@item dcc_upload_path -Path for reading files when sending thru dcc (when no path is specified)@* -Type: string (any string), default value: '~'@* -@item dcc_convert_spaces -Convert spaces to underscores when sending files@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_rename -Rename incoming files if already exists (add '.1', '.2', ...)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_resume -Automatically resume dcc transfer if connection with remote host is loosed@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item proxy_use -Use a proxy server to connect to irc server@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_type -Proxy type (http (default), socks4, socks5)@* -Type: string (values: 'http', 'socks4', 'socks5'), default value: 'http'@* -@item proxy_ipv6 -Connect to proxy in ipv6@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_address -Proxy server address (IP or hostname)@* -Type: string (any string), default value: ''@* -@item proxy_port -Port for connecting to proxy server@* -Type: integer (values: between 0 and 65535), default value: 3128@* -@item proxy_username -Username for proxy server@* -Type: string (any string), default value: ''@* -@item proxy_password -Password for proxy server@* -Type: string (any string), default value: ''@* -@item plugins_path -Path for searching plugins@* -Type: string (any string), default value: '~/.weechat/plugins'@* -@item plugins_autoload -Comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "libperl.so")@* -Type: string (any string), default value: '*'@* -@item plugins_extension -Standard plugins extension in filename, used for autoload (if empty, then all files are loaded when autoload is "*")@* -Type: string (any string), default value: '.so'@* -@item server_name -Name associated to IRC server (for display only)@* -Type: string (any string), default value: ''@* -@item server_autoconnect -Automatically connect to server when WeeChat is starting@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect -Automatically reconnect to server when disconnected@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect_delay -Delay (in seconds) before trying again to reconnect to server@* -Type: integer (values: between 0 and 65535), default value: 30@* -@item server_address -IP address or hostname of IRC server@* -Type: string (any string), default value: ''@* -@item server_port -Port for connecting to server@* -Type: integer (values: between 0 and 65535), default value: 6667@* -@item server_ipv6 -Use IPv6 protocol for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_ssl -Use SSL for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_password -Password for IRC server@* -Type: string (any string), default value: ''@* -@item server_nick1 -Nickname to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_nick2 -Alternate nickname to use on IRC server (if nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_nick3 -2nd alternate nickname to use on IRC server (if alternate nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_username -User name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_realname -Real name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_command -First command to run when connected to server@* -Type: string (any string), default value: ''@* -@item server_command_delay -Delay (in seconds) after command was executed (example: give some time for authentication)@* -Type: integer (values: between 0 and 5), default value: 0@* -@item server_autojoin -Comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")@* -Type: string (any string), default value: ''@* -@item server_autorejoin -Automatically rejoin channels when kicked@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_notify_levels -Comma separated list of notify levels for channels of this server (format: #channel:1,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_iso -Comma separated list of charsets for server and channels, to decode ISO (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_utf -Comma separated list of charsets for server and channels, to decode UTF (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_encode -Comma separated list of charsets for server and channels, to encode messages (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@end table - -Colors for Curses GUI are:@* -@itemize @minus -@item -@kbd{default}: default color (transparent for background) -@item -@kbd{black}: black -@item -@kbd{red}: dark red -@item -@kbd{lightred}: light red -@item -@kbd{green}: dark green -@item -@kbd{lightgreen}: light green -@item -@kbd{brown}: brown -@item -@kbd{yellow}: yellow -@item -@kbd{blue}: dark blue -@item -@kbd{lightblue}: light blue -@item -@kbd{magenta}: dark magenta -@item -@kbd{lightmagenta}: light magenta -@item -@kbd{cyan}: dark cyan -@item -@kbd{lightcyan}: light cyan -@item -@kbd{white}: white -@end itemize - -@node Key bindings, WeeChat commands, Config file, 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 / Ctrl + A -Go to the beginning of command line@* -@* -@item End / Ctrl + E -Go to the end of command line@* -@* -@item Ctrl + K -Delete until end of line@* -@* -@item Ctrl + L -Redraw whole window@* -@* -@item Ctrl + U -Delete until beginning of line@* -@* -@item Ctrl + W -Erase previous word of command line@* -@* -@item Backspace / Delete -Erase previous / next char 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 Ctrl + up arrow / Ctrl + down arrow -Call again last commands/messages in global history@* -@* -@item PageUp / PageDown -Show buffer history@* -@*
-@item F5 / F6 -Switch to previous / next buffer@* -@* -@item F7 / F8 -Switch to previous / next window@* -@* -@item F10 -Remove last infobar message@* -@* -@item F11 / F12 -Scroll nicklist@* -@* -@item Alt + left arrow / Alt + right arrow -Same as F5 / F6@* -@* -@item Alt + A -Switch to next buffer with activity (with priority: highlight, message, other)@* -@* -@item Alt + B -Go to previous word@* -@* -@item Alt + D -Delete next word@* -@* -@item Alt + F -Go to next word@* -@* -@item Alt + H -Clear hotlist (activity notification on other buffers)@* -@* -@item Alt + J then Alt + D -Display current DCC@* -@* -@item Alt + J then Alt + L -Switch to last buffer@* -@* -@item Alt + J then Alt + S -Switch to server buffer@* -@* -@item Alt + J then Alt + X -Switch to first channel of next server (or server buffer if no channel is opened)@* -@* -@item Alt + digit (1-9) -Switch to buffer by number@* -@* -@item Alt + J then number (01-99) -Switch to buffer by number@* -@* -@item Alt + K -Grab a key -@* -@item Alt + N -Scroll to next highlight@* -@* -@item Alt + P -Scroll to previous highlight@* -@* -@item Alt + R -Delete entire line@* -@* -@item Alt + S -Switch server on servers buffer@* -(if option ``look_one_server_buffer'' is enabled)@* -@* -@item Alt + U -Scroll to first unread line in buffer@* -@* -@item Alt + W then Alt + arrow -Switch to window with direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Scroll nicklist@* -@* -@end table - -@node WeeChat commands, FIFO pipe, Key bindings, Usage -@section WeeChat commands - -WeeChat internal commands:@* - -@table @kbd -@item alias [alias_name [command [arguments]] -@* -create an alias for a command@* -@* -alias_name: name of alias@* -command: command name (WeeChat or IRC command, without first '/')@* -arguments: arguments for command@* -@* -@item buffer [action | number | [[server] [channel]]] -@* -manage buffers@* -@* -action: action to do:@* - move: move buffer in the list (may be relative, for example -1)@* - close: close buffer (for channel: same as /part without part message)@* - list: list opened buffers (no parameter implies this list)@* - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)@* -server,channel: jump to buffer by server and/or channel name@* -number: jump to buffer by number@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -change charset for server or channel@* -@* -decode_iso: charset used for decoding ISO@* -decode_utf: charset used for decoding UTF@* - encode: charset used for encoding messages@* - charset: charset to use (for example: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -clear window(s)@* -@* --all: clear all windows@* -@* -@item connect [servername] -@* -connect to a server@* -@* -servername: server name to connect@* -@* -@item disconnect [servername] -@* -disconnect from a server@* -@* -servername: server name to disconnect@* -@* -@item debug dump | windows -@* -print debug messages@* -@* -dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)@* -windows: display windows tree@* -@* -@item help [command] -@* -display help about commands@* -@* -command: name of a WeeChat or IRC command@* -@* -@item history [clear | value] -@* -show buffer command history@* -@* -clear: clear history@* -value: number of history entries to show@* -@* -@item ignore [mask [[type | command] [channel [server]]]] -@* -ignore IRC messages and/or hosts@* -@* - mask: nick or host mask to ignore@* - type: type of message to ignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for ignore@* - server: name of server for ignore@* -@* -For each argument, '*' means all.@* -Without argument, /ignore command lists all defined ignore.@* -@* -@item key [key function/command] [unbind key] [functions] [reset -yes] -@* -bind/unbind keys@* -@* -key: bind this key to an internal function or a command (beginning by "/")@* -unbind: unbind a key (if "all", default bindings are restored)@* -functions: list internal functions for key bindings@* -reset: restore bindings to the default values and delete ALL personal binding (use carefully!)@* -@* -@item plugin [load filename] | [autoload] | [reload] | [unload] -@* -list/load/unload plugins@* -@* -filename: WeeChat plugin (file) to load@* -@* -Without argument, /plugin command lists all loaded plugins.@* -@* -@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] -@* -list, add or remove servers@* -@* -servername: server name, for internal & display use@* -hostname: name or IP address of server@* -port: port for server (integer)@* -ipv6: use IPv6 protocol@* -ssl: use SSL protocol@* -password: password for server@* -nick1: first nick for server@* -nick2: alternate nick for server@* -nick3: second alternate nick for server@* -username: user name@* -realname: real name of user@* -@* -@item save [file] -@* -save config to disk@* -@* -file: filename for writing config@* -@* -@item set [option [ = value]] -@* -set config parameters@* -@* -option: name of an option (if name is full and no value is given, then help is displayed on option)@* -value: value for option@* -@* -@item unalias alias_name -@* -remove an alias@* -@* -alias_name: name of alias to remove@* -@* -@item unignore [number | [mask [[type | command] [channel [server]]]]] -@* -unignore IRC messages and/or hosts@* -@* - number: # of ignore to unignore (number is displayed by list of ignore)@* - mask: nick or host mask to unignore@* - type: type of message to unignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for unignore@* - server: name of server for unignore@* -@* -For each argument, '*' means all.@* -Without argument, /unignore command lists all defined ignore.@* -@* -@item upgrade -@* -upgrade WeeChat without disconnecting from servers@* -@* -@item uptime [-o] -@* -show WeeChat uptime@* -@* --o: send uptime on current channel as an IRC message@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]] -@* -manage windows@* -@* -list: list opened windows (no parameter implies this list)@* --1: jump to previous window@* -+1: jump to next window@* -b#: jump to next window displaying buffer number #@* -up: switch to window above current one@* -down: switch to window below current one@* -left: switch to window on the left@* -right: switch to window on the right@* -splith: split current window horizontally@* -splitv: split current window vertically@* -resize: resize window size, new size is <pct>%% of parent window@* -merge: merge window with another (all = keep only one window)@* -@* -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4@* -@* -@end table - -IRC commands:@* - -@table @kbd -@item admin [target] -@* -find information about the administrator of the server@* -@* -target: server@* -@* -@item ame message -@* -send a CTCP action to all channels of all connected servers@* -@* -message: message to send@* -@* -@item amsg text -@* -send message to all channels of all connected servers@* -@* -text: text to send@* -@* -@item away [-all] [message] -@* -toggle away status@* -@* --all: toggle away status on all connected servers@* -message: message for away (if no message is given, away status is removed)@* -@* -@item ban [channel] [nickname [nickname ...]] -@* -bans nicks or hosts@* -@* -channel: channel for ban@* -nickname: user or host to ban@* -@* -@item ctcp nickname type [arguments] -@* -send a CTCP message (Client-To-Client Protocol)@* -@* -nickname: user to send CTCP to@* -type: CTCP type (examples: "version", "ping", ..)@* -arguments: arguments for CTCP@* -@* -@item dcc action [nickname [file]] -@* -starts DCC (file or chat) or close chat@* -@* -action: 'send' (file) or 'chat' or 'close' (chat)@* -nickname: nickname to send file or chat@* -file: filename (on local host)@* -@* -@item dehalfop [nickname [nickname]] -@* -removes half channel operator status from nickname(s)@* -@* -@item deop [nickname [nickname]] -@* -removes channel operator status from nickname(s)@* -@* -@item devoice [nickname [nickname]] -@* -removes voice from nickname(s)@* -@* -@item die -@* -shutdown the server@* -@* -@item halfop [nickname [nickname]] -@* -gives half channel operator status to nickname(s)@* -@* -@item info [target] -@* -get information describing the server@* -@* -target: server name@* -@* -@item invite nickname channel -@* -invite a nick on a channel@* -@* -nickname: nick to invite@* -channel: channel to invite@* -@* -@item ison nickname [nickname ...] -@* -check if a nickname is currently on IRC@* -@* -nickname: nickname@* -@* -@item join channel[,channel] [key[,key]] -@* -join a channel@* -@* -channel: channel name to join@* -key: key to join the channel@* -@* -@item kick [channel] nickname [comment] -@* -forcibly remove a user from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick@* -comment: comment for kick@* -@* -@item kickban [channel] nickname [comment] -@* -kicks and bans a nick from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick and ban@* -comment: comment for kick@* -@* -@item kill nickname comment -@* -close client-server connection@* -@* -nickname: nickname@* -comment: comment for kill@* -@* -@item links [[server] server_mask] -@* -list all servernames which are known by the server answering the query@* -@* -server: this server should answer the query@* -server_mask: list of servers must match this mask@* -@* -@item list [channel[,channel] [server]] -@* -list channels and their topic@* -@* -channel: channel to list@* -server: server name@* -@* -@item lusers [mask [target]] -@* -get statistics about the size of the IRC network@* -@* -mask: servers matching the mask only@* -target: server for forwarding request@* -@* -@item me message -@* -send a CTCP action to the current channel@* -@* -message: message to send@* -@* -@item mode @{ channel @{[+|-]|o|p|s|i|t|n|b|v@} [limit] [user] [ban mask] @} | @{ nickname @{[+|-]|i|w|s|o@} @} -@* -change channel or user mode@* -@* -channel modes:@* - channel: channel name to modify@* - o: give/take channel operator privileges@* - p: private channel flag@* - s: secret channel flag@* - i: invite-only channel flag@* - t: topic settable by channel operator only flag@* - n: no messages to channel from clients on the outside@* - m: moderated channel@* - l: set the user limit to channel@* - b: set a ban mask to keep users out@* - e: set exception mask@* - v: give/take the ability to speak on a moderated channel@* - k: set a channel key (password)@* -user modes:@* - nickname: nickname to modify@* - i: mark a user as invisible@* - s: mark a user for receive server notices@* - w: user receives wallops@* - o: operator flag@* -@* -@item motd [target] -@* -get the "Message Of The Day"@* -@* -target: server name@* -@* -@item msg receiver[,receiver] text -@* -send message to a nick or channel@* -@* -receiver: nick or channel (may be mask, '*' = current channel)@* -text: text to send@* -@* -@item names [channel[,channel]] -@* -list nicknames on channels@* -@* -channel: channel name@* -@* -@item nick [-all] nickname -@* -change current nickname@* -@* --all: set new nickname for all connected servers@* -nickname: new nickname@* -@* -@item notice nickname text -@* -send notice message to user@* -@* -nickname: user to send notice to@* -text: text to send@* -@* -@item op nickname [nickname] -@* -gives channel operator status to nickname(s)@* -@* -@item oper user password -@* -get operator privileges@* -@* -user/password: used to get privileges on current IRC server@* -@* -@item part [channel[,channel]] [part_message] -@* -leave a channel@* -@* -channel: channel name to leave@* -part_message: part message (displayed to other users)@* -@* -@item ping server1 [server2] -@* -ping server@* -@* -server1: server to ping@* -server2: forward ping to this server@* -@* -@item pong daemon [daemon2] -@* -answer to a ping message@* -@* -daemon: daemon who has responded to Ping message@* -daemon2: forward message to this daemon@* -@* -@item query nickname [text] -@* -send a private message to a nick@* -@* -nickname: nickname for private conversation@* -text: text to send@* -@* -@item quit [quit_message] -@* -close all connections & quit@* -@* -quit_message: quit message (displayed to other users)@* -@* -@item quote data -@* -send raw data to server without parsing@* -@* -data: raw data to send@* -@* -@item rehash -@* -tell the server to reload its config file@* -@* -@item restart -@* -tell the server to restart itself@* -@* -@item service nickname reserved distribution type reserved info -@* -register a new service@* -@* -distribution: visibility of service@* -type: reserved for future usage@* -@* -@item servlist [mask [type]] -@* -list services currently connected to the network@* -@* -mask: list only services matching this mask@* -type: list only services of this type@* -@* -@item squery service text -@* -deliver a message to a service@* -@* -service: name of service@* -text: text to send@* -@* -@item squit server comment -@* -disconnect server links@* -@* -server: server name@* -comment: comment for quit@* -@* -@item stats [query [server]] -@* -query statistics about server@* -@* -query: c/h/i/k/l/m/o/y/u (see RFC1459)@* -server: server name@* -@* -@item summon user [target [channel]] -@* -give users who are on a host running an IRC server a message asking them to please join IRC@* -@* -user: username@* -target: server name@* -channel: channel name@* -@* -@item time [target] -@* -query local time from server@* -@* -target: query time from specified server@* -@* -@item topic [channel] [topic] -@* -get/set channel topic@* -@* -channel: channel name@* -topic: new topic for channel (if topic is "-delete" then topic is deleted)@* -@* -@item trace [target] -@* -find the route to specific server@* -@* -target: server@* -@* -@item unban [channel] nickname [nickname ...] -@* -unbans nicks or hosts@* -@* -channel: channel for unban@* -nickname: user or host to unban@* -@* -@item userhost nickname [nickname ...] -@* -return a list of information about nicknames@* -@* -nickname: nickname@* -@* -@item users [target] -@* -list of users logged into the server@* -@* -target: server@* -@* -@item version [server | nickname] -@* -gives the version info of nick or server (current or specified)@* -@* -server: server name@* -nickname: nickname@* -@* -@item voice [nickname [nickname]] -@* -gives voice to nickname(s)@* -@* -@item wallops text -@* -send a message to all currently connected users who have set the 'w' user mode for themselves@* -@* -text to send@* -@* -@item who [mask ["o"]] -@* -generate a query which returns a list of information@* -@* -mask: only information which match this mask@* -o: only operators are returned according to the mask supplied@* -@* -@item whois [server] nickname[,nickname] -@* -query information about user(s)@* -@* -server: server name@* -nickname: nickname (may be a mask)@* -@* -@item whowas nickname [,nickname [,nickname ...]] [count [target]] -@* -ask for information about a nickname which no longer exists@* -@* -nickname: nickname to search@* -count: number of replies to return (full search if negative number)@* -target: reply should match this mask@* -@* -@end table - -Internal functions for keys:@* - -@table @kbd -@item return -terminate line@* -@item tab -complete word@* -@item backspace -delete previous char@* -@item delete -delete next char@* -@item delete_end_line -delete until end of line@* -@item delete_beginning_line -delete until beginning of line@* -@item delete_line -delete entire line@* -@item delete_previous_word -delete previous word@* -@item delete_next_word -delete next word@* -@item clipboard_paste -paste current clipboard content@* -@item transpose_chars -transpose chars@* -@item home -go to beginning of line@* -@item end -go to end of line@* -@item left -move one char left@* -@item previous_word -move to previous word@* -@item right -move one char right@* -@item next_word -move to next word@* -@item up -call previous command in history@* -@item up_global -call previous command in global history@* -@item down -call next command in history@* -@item down_global -call next command in global history@* -@item page_up -scroll one page up@* -@item page_down -scroll one page down@* -@item nick_beginning -display beginning of nicklist@* -@item nick_end -display end of nicklist@* -@item nick_page_up -scroll nicklist one page up@* -@item nick_page_down -scroll nicklist one page down@* -@item jump_smart -jump to buffer with activity@* -@item jump_dcc -jump to DCC buffer@* -@item jump_last_buffer -jump to last buffer@* -@item jump_server -jump to server buffer@* -@item jump_next_server -jump to next server@* -@item switch_server -switch active server on servers buffer@* -@item scroll_previous_highlight -scroll to previous highlight in buffer@* -@item scroll_next_highlight -scroll to next highlight in buffer@* -@item scroll_unread -scroll to first unread line in buffer@* -@item hotlist_clear -clear hotlist@* -@item infobar_clear -clear infobar@* -@item refresh -refresh screen@* -@item grab_key -grab a key@* -@end table - -@node FIFO pipe, , WeeChat commands, Usage -@section FIFO pipe - -You can remote control WeeChat, by sending commands or text to a FIFO pipe -(you have to enable option "irc_fifo_pipe", it is disabled by default).@* -The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" -(where xxxxx is the process ID (PID) of running WeeChat).@* -So if many WeeChat are running, you have many FIFO pipe, one for each session.@* -@* -The syntax for the FIFO pipe commands/text is:@* -@command{server,channel *text or command here}@* -where server and channel are optional, but if channel is here, server should be too.@* -@* -Some examples: -@table @asis -@item @bullet{} change your nick on freenode to "mynick|out": -@* -@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on #weechat channel: -@* -@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on current channel (buffer displayed by WeeChat): -@* -@command{echo "*hello!" >~/.weechat/weechat_fifo_12345} -@* -@b{Warning:} this is dangerous and you should not do that except if you know what you do! -@* -@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -You can write a script to send command to all running WeeChat at same time, for example:@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -If the script is called "auto_weechat_command", you can run it with:@* -@command{./auto_weechat_command "freenode,#weechat *hello"} - - -@c ******************************** Plugins *********************************** - -@node Plugins, Authors / Support, Usage, Top -@chapter Plugins - -@menu -* Plugins in WeeChat:: -* Write a plugin:: -* Plugin example:: -* Scripts plugins:: -@end menu - -@node Plugins in WeeChat, Write a plugin, Plugins, Plugins -@section Plugins in WeeChat - -A plugin is a C program which can call WeeChat functions defined in an -interface.@* -@* -This C program does not need WeeChat sources to compile and can be -dynamically loaded into WeeChat with command @command{/plugin}.@* -@* -The plugin has to be a dynamic library, for dynamic loading by -operating system. -Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under -Windows. - -@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins -@section Write a plugin - -@subsection Base rules - -The plugin should include ``weechat-plugin.h'' file (available in -WeeChat source code).@* -This file defines structures and types used to communicate with WeeChat.@* -@* -The plugin must have some variables and functions (mandatory, without -them the plugin can't load):@* -@itemize @bullet -@item variables for plugin description: -@itemize @minus -@item plugin_name[]: plugin name -@item plugin_version[]: plugin version -@item plugin_description[]: short description of plugin -@end itemize -@item functions for init and end of plugin: -@itemize @minus -@item weechat_plugin_init: function called when plugin is loaded, -must return PLUGIN_RC_OK if successful, PLUGIN_RC_KO if error -@item weechat_plugin_end: function called when plugin is unloaded -@end itemize -@end itemize - -@subsection API functions - -The plugin can call some functions defined in t_weechat_plugin -structure.@* -@* -These functions are detailed below:@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Locale and case independent string comparison.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Locale and case independent string comparison, for ``max'' chars.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@item @option{max}: max number of chars for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explode a string according to one or more delimiter(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string to explode -@item @option{separators}: delimiters used for explosion -@item @option{num_items_max}: maximum number of items created (0 means -no limit) -@item @option{num_items}: pointer to int which will contain number of -items created -@end itemize -@* -@emph{Return value:}@* -@* -Array of strings, NULL if problem.@* -Note: the result has to be free by a call to ``free_exploded_string'' -function after use.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Free memory used by a string explosion.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string exploded by ``explode_string'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Execute a function on all files of a directory.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{directory}: directory for searching files -@item @option{callback}: function called for each file found -@end itemize -@* -@emph{Return value:}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "file: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Display a message on a WeeChat buffer, identified by server and -channel (both may be NULL for current buffer).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server to find buffer for message -display (may be NULL) -@item @option{channel}: name of channel to find buffer for message -display (may be NULL) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Display a message on server buffer.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Display a message in infobar for a specified time.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{time}: time in seconds for displaying message (0 means -never erased) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Add an IRC message handler, called when an IRC message is received.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: IRC message (for example: ``PRIVMSG'') -@item @option{handler_func}: function called when message is received -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new message handler.@* -@* -@emph{Example:}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK received");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to -WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to -other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Add a WeeChat command handler, called when user uses command -(for example /command).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{command}: the new command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@item @option{handler_func}: function called when comand is executed -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new command handler.@* -@* -@emph{Example:}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "test command, -file: %s", (arguments) ? arguments : "none");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Test command", -"[file]", "file: a file name", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Remove a handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{handler}: handler to remove -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Remove all handlers for a plugin.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute a WeeChat command (or send a message to a channel).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server for executing command (may be -NULL) -@item @option{channel}: name of channel for executing command (may be -NULL) -@item @option{command}: command -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Return an info about WeeChat or a channel.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{info}: name of info to read: -@itemize @minus -@item @option{version}: get WeeChat's version -@item @option{nick}: get nick -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir -@end itemize -@item @option{server}: name of server for reading info (if needed) -@end itemize -@* -@emph{Return value:}@* -@* -Information asked, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Returns list of DCC currently active or finished.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -Chained list of DCC.@* -Note: result has to be free by a call to ``free_dcc_info'' function -after use.@* -@* -@emph{Example:}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, with: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Free memory used by a DCC list.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{dcc_info}: pointer to DCC list returned by -``get_dcc_info'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.option=value}@* -Note: plugin name is automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Example:}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "my_var");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.option=value}@* -Note: plugin name is automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_plugin_config (plugin, "my_var", "value");}@* -@* - -@end itemize - -@subsection Compile plugin - -Compile does not need WeeChat sources, only file -``weechat-plugin.h''.@* - -To compile a plugin which has one file ``toto.c'' (sous GNU/Linux):@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Load plugin under WeeChat - -Copy ``libtoto.so'' file into general plugins dir (for example -/usr/local/lib/weechat/plugins) or into user's plugins dir (for -example /home/xxxxx/.weechat/plugins).@* -@* -Under WeeChat:@* -@command{/plugin load toto} - -@node Plugin example, Scripts plugins, Write a plugin, Plugins -@section Plugin example - -Full example of plugin, which adds a /double command, which displays -two times arguments on current channel (ok that's not very useful, but -that's just an example!):@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/hello" command handler */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -@end verbatim - -@node Scripts plugins, , Plugin example, Plugins -@section Scripts plugins - -Three plugins are provided with WeeChat to use script languages: Perl, -Python and Ruby. - -@subsection Load/unload scripts - -Perl scripts are loaded and unloaded with @command{/perl}, -@command{/python} and @command{/ruby} commands. -(type @kbd{/help} within WeeChat to get help about commands).@* - -@emph{Examples:}@* -@itemize @bullet -@item -Load a Perl script: @kbd{/perl load /tmp/sample.pl}@* -@item -Unload all Perl scripts: @kbd{/perl unload}@* -@item -List all Perl scripts: @kbd{/perl}@* -@item -Load a Python script: @kbd{/python load /tmp/sample.py}@* -@item -Unload all Python scripts: @kbd{/python unload}@* -@item -List all Python scripts: @kbd{/python}@* -@end itemize - -@subsection WeeChat / Scripts API - -@itemize @bullet -@item -Perl: @command{weechat::register ( name, version, shutdown_function, -description );}@* -Python: @command{weechat.register ( name, version, shutdown_function, -description )}@* -@* -This is first function to call in script.@* -All 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}: 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{Return value:}@* -@* -1 if script was registered, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::register ("sample", "1.0", "sample_end", "Sample -script!");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.register ("sample", "1.0", "sample_end", "Sample -script!")}@* -@* - -@item -Perl: @command{weechat::print ( message, [channel, [server]] );}@* -Python: @command{weechat.prnt ( message, [channel, [server]] )}@* -@* -Print message in a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{message}: message to display -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( delay, message );}@* -Python: @command{weechat.print_infobar ( delay, message )}@* -@* -Print message in infobar.@* - -@emph{Arguments:} -@itemize @minus -@item @option{delay}: after this delay (in seconds), message will be erased -(if 0, message will not be erased). -@item @option{message}: message to display -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( name, function );}@* -Python: @command{weechat.add_message_handler ( name, function )}@* -@* -Attach a script 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}: function called when message is received -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_message_handler ("privmsg", my_function);}@* -@code{sub my_function}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("server=$_[0]\n");}@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* -@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_message_handler ("privmsg", my_function)}@* -@code{def my_function(server, args):}@* -@code{@ @ @ @ weechat.prnt("server="+server)}@* -@code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent -to WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent -to other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Create new WeeChat command, linked with script 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 -script function. Be careful when overriding WeeChat commands, they'll not be -available until your script will be unloaded. -@item @option{function}: function linked with command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_command_handler ("command", my_command);}@* -@code{sub my_command}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_command_handler ("command", my_command)}@* -@code{def my_command(server, args):}@* -@code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( name, function );}@* -Python: @command{weechat.remove_handler ( name, function )}@* -@* -Remove a message or command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of IRC message or command handler -@item @option{function}: function -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::remove_handler ("command", my_command);}@* -@* -@emph{Python example:}@* -@* -@code{weechat.remove_handler ("command", my_command)}@* -@* - -@item -Perl: @command{weechat::command ( command, [channel, [server]] );}@* -Python: @command{weechat.command ( command, [channel, [server]] )}@* -@* -Execute a command or send a message to a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{command}: command to execute (or message to send in a channel) -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::command ("hello world!");}@* -@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.command ("hello world!")}@* -@code{weechat.command ("/kick toto please leave this chan", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( name, [server] );}@* -Python: @command{weechat.get_info ( name, [server] )}@* -@* -Get various info about WeeChat, server or user.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of info to retrieve: -@itemize @minus -@item @option{version}: get WeeChat version -@item @option{nick}: get nickname -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir - -@end itemize -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -Asked info, empty if error occured or info was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$version = weechat::get_info("version");}@* -@code{$nick = weechat::get_info("nick", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{$version = weechat.get_info("version")}@* -@code{$nick = weechat.get_info("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( );}@* -@* -Get DCC list.@* - -Returned array has following fields: -@itemize @minus -@item server: IRC server -@item channel: IRC channel -@item type: DCC type: -@itemize @minus -@item 0: chat (received) -@item 1: chat (sent) -@item 2: file (receiving) -@item 3: file (sending) -@end itemize -@item status: DCC status: -@itemize @minus -@item 0: waiting -@item 1: connecting -@item 2: active -@item 3: done -@item 4: failed -@item 5: aborted -@end itemize -@item start_time: date/time of DCC creation -@item start_transfer: date/time of transfer start -@item addr: remote address -@item port: port used for DCC -@item nick: remote nick -@item filename: filename -@item local_filename: local filename -@item size: file size -@item pos: current position in file -@item start_resume: restart position after interruption -@item bytes_per_sec: bytes sent/received per second -@end itemize -@* -@emph{Return value:}@* -@* -DCC list, 0 if error occured.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Python examples:}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, value );}@* -Python: @command{weechat.set_config ( option, value )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin"", -"#weechat");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl example:}@* -@* -@code{$value = weechat::get_plugin_config ("my_var");}@* -@* -@emph{Python example:}@* -@* -@code{$value = weechat.get_plugin_config ("my_var")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, value );}@* -Python: @command{weechat.set_plugin_config ( option, value )}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::set_plugin_config ("my_var", "value");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.set_plugin_config ("my_var", "value")}@* -@* - -@end itemize - - -@c **************************** Authors / Support ***************************** - -@node Authors / Support, , Plugins, 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}> - -@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: @uref{http://forums.flashtux.org}@*@* -@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{} 2005 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_es.texi b/weechat/doc/weechat_doc_es.texi deleted file mode 100644 index 3f424d89f..000000000 --- a/weechat/doc/weechat_doc_es.texi +++ /dev/null @@ -1,2911 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename weechat_doc_es.info -@settitle WeeChat - Cliente IRC r@'apido, ligero y extensible -@c %**end of header - -@c WeeChat documentation (spanish version) -@c -@c Copyright (c) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@c pdf : texi2pdf weechat_doc_es.texi -@c html: makeinfo --html --no-split --number-sections weechat_doc_es.texi - -@c tex -@c \overfullrule=0pt -@c end tex - -@documentlanguage es -@documentencoding ISO-8859-1 - -@titlepage - -@title WeeChat - Gui@'on de usuario. -@subtitle Cliente IRC r@'apido, peque@~no y extensible -@subtitle Documentaci@'on para WeeChat v0.1.7-cvs - 16 de diciembre de 2005 - -@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> - -@page - -Este manual documenta el cliente de IRC WeeChat, y hace parte del proyecto.@* -@* -Puede obtener la @`ultima versi@'on de este documento en la p@'agina:@* -@uref{http://weechat.flashtux.org/doc.php}@* -@* -Copyright @copyright{} 2005 FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* -Traducido en espa@~nol por Iznogoud <@email{iznogoud@@dlfp.org, iznogoud AT dlfp.org}>@* -@* -Puede utilizar este documento seg@'un los t@'erminos de la licencia GNU General Public -License versi@'on 2 o posterior. - -@end titlepage - -@everyheading @thischapter @| @| -@everyfooting @thistitle @| @| Page @thispage - -@contents - -@node Top, Introduccion, (dir), (dir) -@menu -* Introduccion:: Presentaci@'on de WeeChat -* Instalacion:: Instalaci@'on de WeeChat -* Uso:: Utilizaci@'on de WeeChat -* Plugins:: WeeChat plugins -* Autores / Soporte:: Contactar los autores y obtener soporte -@end menu - - -@c ******************************* Introducci'on ******************************* - -@node Introduccion, Instalacion, Top, Top -@chapter Introducci@'on -@menu -* Descripcion:: -* Requisitos:: -@end menu - -@node Descripcion, Requisitos, Introduccion, Introduccion -@section Descripci@'on - -WeeChat (Wee Enhanced Environment for Chat) es un cliente de IRC libre, r@'apido y de peque@~no tama@~no, -dise@~nado para diferentes sistemas operativos.@* -@* -Las caracter@'isticas principales son las siguientes: -@itemize @minus -@item -conexi@'on multi-servidores (con SSL, IPv6, proxy) -@item -m@'ultiples interfaces: Curses, wxWidgets, Gtk y Qt -@item -peque@~no, r@'apido y ligero. -@item -parametrizable y extensible mediante guiones (scripts) -@item -conforme a las RFCs 1459, 2810, 2811, 2812, y 2813 -@item -multi-plataforma (Gnu/Linux, *BSD, MacOS X, Windows y otros sistemas operativos) -@item -100% GPL, con Licencia Libre -@end itemize - -@* -La p@'agina Web de WeeChat est@'a aqu@'i (en franc@'es):@* -@uref{http://weechat.flashtux.org}@* - -@node Requisitos, , Descripcion, Introduccion -@section Requisitos - -Los requisitos para instalar WeeChat son:@* - -@itemize @bullet -@item -Un sistema operativo GNU/Linux (con compilador y herramientas asociadas para paquetes de c@'odigo fuente) -@item -Acceso a la cuenta "root" (para instalar WeeChat) -@item -Seg@'un el interfaz, una de las bibliotecas siguientes: -@itemize @minus -@item -Curses: la librer@'ia ncurses, -@item -Gtk: *** interfaz no desarrollada por el momento ***, -@item -Qt: *** interfaz no desarrollada por el momento ***, -@end itemize -@end itemize - - -@c ******************************* Instalaci@'on ******************************* - -@node Instalacion, Uso, Introduccion, Top -@chapter Instalaci@'on - -@menu -* Paquetes binarios:: -* Paquetes de fuentes:: -* CVS:: -@end menu - -@node Paquetes binarios, Paquetes de fuentes, Instalacion, Instalacion -@section Paquetes binarios - -Los paquetes binarios est@'an disponibles para las siguientes distribuciones: -@itemize @bullet -@item -Debian (o compatible con Debian)@* -Para instalar WeeChat: @kbd{apt-get install weechat-curses} -@item -Mandrake/Redhat (o cualquier distribuci@'on compatible con los paquetes RPM)@* -Para instalar WeeChat: @kbd{rpm -i /direccion/weechat-x.y.z-1.i386.rpm} -@item -Gentoo@* -Para instalar WeeChat: @kbd{emerge -pf weechat && emerge weechat} -@item -BSD (no disponible !) -@item -Slackware (no disponible!) -@item -Windows (no disponible!) -@end itemize - -donde x.y.z es la versi@'on de WeeChat (por ejemplo 0.0.1) -@* - -@node Paquetes de fuentes, CVS, Paquetes binarios, Instalacion -@section Paquetes de fuentes - -Escribe en un terminal o una consola:@* -@kbd{./configure}@* -@kbd{make}@* -Nota: si quieres construir WeeChat @'unicamente para ciertas interfaces, puedes a@~nadir Par@'ametros a -./configure, escribe @kbd{./configure --help} para obtener ayuda sobre estas opciones.@* - -Adquiere los derechos de root e instala WeeChat:@* -@kbd{su}@* -(introduce la contrase@~na de root)@* -@kbd{make install}@* - -@node CVS, , Paquetes de fuentes, Instalacion -@section CVS - -Atenci@'on: Las fuentes CVS est@'an reservadas para usuarios con experiencia: Es posible que WeeChat no -se instale o que se sea bastante inestable. -@exclamdown{}Ya te he avisado!@* - -Para recuperar las fuentes CVS, escribe las l@'ineas siguientes:@* -@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* -@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* -(Si te pregunta una contrase@~na, simplemente pulsa la tecla Entrar)@* - -Ejecuta el script:@* -@kbd{./autogen.sh}@* - -Luego, lee las instructiones para Paquetes de fuentes - @xref{Paquetes de fuentes}. - - -@c ******************************* Utilisaci@'on ******************************** - -@node Uso, Plugins, Instalacion, Top -@chapter Uso - -@menu -* Iniciar WeeChat:: -* Ficheros de configuracion:: -* Atajos de teclado:: -* Comandos WeeChat:: -* Canal FIFO:: -@end menu - -@node Iniciar WeeChat, Ficheros de configuracion, Uso, Uso -@section Iniciar WeeChat - -@subsection Par@'ametros de l@'inea de comandos - -@table @code -@item -a, --no-connect -Disable auto-connect to servers at startup@* -@item -c, --config -Obtener la ayuda del fichero de configuraci@'on (lista de opciones)@* -@item -f, --key-functions -Display WeeChat internal functions for keys@* -@item -h, --help -Obtener la ayuda@* -@item -i, --irc-commands -Display IRC commands list@* -@item -k, --keys -Display WeeChat default keys@* -@item -l, --license -Obtener la licencia de WeeChat@* -@item -p, --no-plugin -Don't load any plugin at startup -@item -v, --version -Obtener la versi@'on de WeeChat@* -@item -w, --weechat-commands -Display WeeChat commands list@* -@end table - -@subsection Lanzar WeeChat - -Para ejecutar WeeChat, basta escribir la l@'inea siguiente:@* -@kbd{weechat-curses} (para el interfaz con Curses)@* -o @kbd{weechat-wxwidgets} (para el interfaz con wxWidgets)@* -o @kbd{weechat-gtk} (para el interfaz con Gtk)@* -o @kbd{weechat-qt} (para el interfaz con Qt)@* - -Cuando se ejecuta WeeChat por primera vez, un fichero de configuraci@'on se crea con las opciones por defecto;@* -El fichero de configuraci@'on por defecto est@'a en: ~/.weechat/weechat.rc@* - -Puedes editarlo para configurar WeeChat con las opciones deseadas, o tambi@'en puedes modificar los par@'ametros directamente en WeeChat, con la l@'inea @kbd{/set} - @xref{Comandos WeeChat}. - -@node Ficheros de configuracion, Atajos de teclado, Iniciar WeeChat, Uso -@section Ficheros de configuraci@'on - -Enumeraci@'on de las opciones del fichero de configuraci@'on:@* - -@table @kbd -@item look_set_title -Define el t@'itulo de la ventana (el terminal para la interfaz Curses) con el nombre y la versi@'on@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_startup_logo -Mostrar el logotipo de WeeChat en el arranque@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_startup_version -Mostrar la versi@'on de Weechat en el arranque@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_weechat_slogan -Esl@'ogan de WeeChat (si est@'a vac@'io, el esl@'ogan no ser@'a utilizado)@* -Typo: cadena (cualquier cadena), valor por defecto: 'the geekest IRC client!'@* -@item look_charset_decode_iso -Juego de caracteres ISO para decodificar mensajes del servidor (usado s@'olo si locale es UTF-8) (si est@'a vac@'io, los mensajes no se convierten si locale es UTF-8@* -Typo: cadena (cualquier cadena), valor por defecto: 'ISO-8859-1'@* -@item look_charset_decode_utf -Juego de caracteres UTF para decodificar mensajes del servidor (usado s@'olo si locale no es UTF-8) (si est@'a vac@'io, los mensajes no se convierten si locale no es UTF-8@* -Typo: cadena (cualquier cadena), valor por defecto: 'UTF-8'@* -@item look_charset_encode -Juego de caracteres para codificar los mensajes enviados al servidor, ejemplos: UTF-8, ISO-8859-1 (si est@'a vac@'io, los mensajes no se convierten)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item look_charset_internal -Fuerza el juego de caracteres interno de Weechat (deber@'ia estar vac@'io en la mayor@'ia de los casos, eso significa que se utiliza el juego de caracteres detectado)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item look_one_server_buffer -Usar el mismo búfer para todos los servidores@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item look_buffer_timestamp -Fecha y hora para las búfers@* -Typo: cadena (cualquier cadena), valor por defecto: '[%H:%M:%S]'@* -@item look_color_nicks_number -Número de colores para usar en los colores de nombres de usuario@* -Typo: entero (valores: entre 1 y 10), valor por defecto: 10@* -@item look_color_actions -Mostrar acciones con colores diferentes@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_nicklist -Mostrar ventana de usuarios (para las ventanas de canal)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_nicklist_position -Posici@'on de la ventana de usuarios (arriba (top), izquierda (left), derecha (right, por defecto), abajo (bottom))@* -Typo: cadena (valores: 'left', 'right', 'top', 'bottom'), valor por defecto: 'right'@* -@item look_nicklist_min_size -Tama@~no m@'inimo para la ventana de usuarios (ancho o alto, dependiendo de look_nicklist_position (0 = sin tama@~no m@'inimo))@* -Typo: entero (valores: entre 0 y 100), valor por defecto: 0@* -@item look_nicklist_max_size -Tama@~no m@'aximo para la ventana de usuarios (ancho o alto, dependiendo de look_nicklist_position (0 = sin tama@~no m@'aximo, si min == max y > 0, entonces se fija el tama@~no))@* -Typo: entero (valores: entre 0 y 100), valor por defecto: 0@* -@item look_no_nickname -Texto a mostrar en lugar del nick cuando no se est@'a conectado@* -Typo: cadena (cualquier cadena), valor por defecto: '-cmd-'@* -@item look_nickmode -Mostrar modo del usuario ((half)op/voice) antes de cada usuario@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_nickmode_empty -Mostrar un espacio si el modo de usuario no es (half)op/voice@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item look_nick_completor -La cadena mostrada tras la finalizaci@'on de los nombres de usuario@* -Typo: cadena (cualquier cadena), valor por defecto: ':'@* -@item look_nick_completion_ignore -Caracteres ignorados para el completado del nombre de usuario@* -Typo: cadena (cualquier cadena), valor por defecto: '[]-^'@* -@item look_infobar -Activa la barra de informaci@'on@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_infobar_timestamp -Fecha y hora para las conversaciones guardadas@* -Typo: cadena (cualquier cadena), valor por defecto: '%B, %A %d %Y'@* -@item look_infobar_seconds -Mostrar segundos en la hora de la barra de herramientas@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_infobar_delay_highlight -Retraso (en segundos) para la notificaci@'on de mensajes en la barra de informaci@'on (0 = desactivar las notificaciones en la barra de informaci@'on)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 7@* -@item look_hotlist_names_count -Número m@'aximo de nombres en la hotlist (0 = no se muestra ninguno, s@'olo los números de búfer)@* -Typo: entero (valores: entre 0 y 32), valor por defecto: 3@* -@item look_hotlist_names_level -Nivel para mostrar mensajes en la hotlist (combinaci@'on de: 1=join/part, 2=mensaje, 4=privado, 8=resaltado, por ejemplo: 12=privado + resaltado)@* -Typo: entero (valores: entre 1 y 15), valor por defecto: 12@* -@item look_hotlist_names_length -Longitud m@'axima de nombres en la hotlist (0 = sin l@'imite)@* -Typo: entero (valores: entre 0 y 32), valor por defecto: 0@* -@item look_day_change -Mostrar un mensaje especial cuando el d@'ia cambia@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item look_day_change_timestamp -Marca de tiempo para la fecha mostrada cuando el d@'ia cambi@'o@* -Typo: cadena (cualquier cadena), valor por defecto: '%a, %d %b %Y'@* -@item look_read_marker -Use a marker on servers/channels to show first unread line@* -Typo: cadena (cualquier cadena), valor por defecto: ' '@* -@item col_real_white -Si se establece, usa el color blanco verdadero, desactivado por defecto para terminales con el fondo blanco (si tu nunca usas un fondo blanco, deber@'ias activar esta opci@'on para ver el blanco verdadero en vez del color de primer plano del terminal por defecto)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item col_title -Color para la barra de t@'itulo@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_title_bg -Color de fondo para la barra de t@'itulo@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_chat -Color para el texto de conversaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_time -Color para la hora en la ventana de conversaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_time_sep -Color para el separador de la hora (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'brown'@* -@item col_chat_prefix1 -Color para el primer o tercer car@'acter de prefijo@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_chat_prefix2 -Color para el car @'acter de en medio del prefijo@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_chat_server -Color para el nombre del servidor@* -Typo: color (color Curses o Gtk), valor por defecto: 'brown'@* -@item col_chat_join -Color para la flecha de join (prefijo)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_chat_part -Color para la flecha de part/quit (prefijo)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item col_chat_nick -Color para los nombres de usuario en las acciones (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_chat_host -Color para los nombres de m@'aquina (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_chat_channel -Color para los nombres de canal en las acciones (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_chat_dark -Color para los separadores oscuros (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'green'@* -@item col_chat_highlight -Color para el alias subrayado (ventana de conversaci@'on)@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_chat_bg -Color de fondo para la ventana de conversaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_read_marker -Color for unread data marker@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_chat_read_marker_bg -Background for unread data marker@* -Typo: color (color Curses o Gtk), valor por defecto: 'magenta'@* -@item col_status -Color para la barra de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_status_delimiters -Color para los delimitadores de la barra de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_status_channel -Color para el canal actual en la barra de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_status_data_msg -Color para una ventana con mensajes nuevos (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_status_private -Color para una ventana con un mensaje privado (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_status_highlight -Color para una ventana con resaltado (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item col_status_data_other -Color para una ventana con nuevos datos (no mensajes) (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_status_more -Color para una ventana con nuevos datos (barra de estado)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_status_bg -Color de fondo para la ventana de estado@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_infobar -Color para el texto de la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'black'@* -@item col_infobar_delimiters -Color para los delimitadores de la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_infobar_highlight -Color para la notificaci@'on en la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_infobar_bg -Color de fondo para la ventana de la barra de informaci@'on@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_input -Color para el texto de entrada@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_input_channel -Color para el texto de entrada (nombre de canal)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_input_nick -Color para el texto de entrada (alias)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_input_delimiters -Color para el texto de entrada (delimitadores)@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_input_bg -Color de fondo para la ventana de entrada@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick -Color para los nombres de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick_away -Color para los usuarios ausentes@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_nick_chanowner -Color para el s@'imbolo de propietario de canal (especificado en unrealircd)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_chanadmin -Color para el s@'imbolo de administrador de canal (especificado en unrealircd)@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_op -Color para el s@'imbolo de operador@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_halfop -Color para el s@'imbolo de semi-operador@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_nick_voice -Color para el s@'imbolo de voz@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_nick_more -Color para '+' al desplazar nicks@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_nick_sep -Color para el separador de alias@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_nick_self -Color para el alias local@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_nick_color1 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'cyan'@* -@item col_nick_color2 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'magenta'@* -@item col_nick_color3 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'green'@* -@item col_nick_color4 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'brown'@* -@item col_nick_color5 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightblue'@* -@item col_nick_color6 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick_color7 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_nick_color8 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightmagenta'@* -@item col_nick_color9 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_nick_color10 -Color para el nombre de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'blue'@* -@item col_nick_private -Color para el otro alias en la ventana privada@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_nick_bg -Color de fondo para los nombres de usuario@* -Typo: color (color Curses o Gtk), valor por defecto: 'default'@* -@item col_chat_dcc_selected -Color para el DCC seleccionado (ventana de conversaci@'in)@* -Typo: color (color Curses o Gtk), valor por defecto: 'white'@* -@item col_dcc_waiting -Color para el estado dcc "esperando"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightcyan'@* -@item col_dcc_connecting -Color para el estado dcc "conectando"@* -Typo: color (color Curses o Gtk), valor por defecto: 'yellow'@* -@item col_dcc_active -Color para el estado dcc "activo"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightblue'@* -@item col_dcc_done -Color para el estado dcc "terminado"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightgreen'@* -@item col_dcc_failed -Color para el estado dcc "fallo"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item col_dcc_aborted -Color para el estado dcc "abortado"@* -Typo: color (color Curses o Gtk), valor por defecto: 'lightred'@* -@item history_max_lines -Número m@'aximo de l@'ineas en el hist@'orico para un servidor/canal/privado (0 = ilimitado)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 4096@* -@item history_max_commands -Número múximo de comandos de usuario en el hist@'orico (0 = ilimitado)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 100@* -@item history_display_default -Número m@'aximo de comandos para mostrar por defecto en el listado del historial (0 = ilimitado)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 5@* -@item log_auto_server -Registrar autom@'aticamente los mensajes de servidor@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_auto_channel -Registrar autom@'aticamente las conversaciones de canal@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_auto_private -Registrar autom@'aticamente las conversaciones privadas@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_plugin_msg -Registrar mensajes de plugins (scripts)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item log_path -Ruta para los archivos de registro (logs) de WeeChat@* -Typo: cadena (cualquier cadena), valor por defecto: '~/.weechat/logs/'@* -@item log_timestamp -Fecha y hora para los registros (ver man strftime para el formato de fecha/hora)@* -Typo: cadena (cualquier cadena), valor por defecto: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Ocultar contrase@~na mostrada por nickserv@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item irc_display_away -Mostrar mensaje en todos los canales cuando se vuelva del estado ausente@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item irc_default_msg_away -Mensaje por defecto para el estado ausente@* -Typo: cadena (cualquier cadena), valor por defecto: 'away'@* -@item irc_default_msg_part -Mensaje por defecto de salida (saliendo de un canal)@* -Typo: cadena (cualquier cadena), valor por defecto: 'WeeChat %v'@* -@item irc_default_msg_quit -Mensaje de fin por defecto ('%v' ser@'a reemplazado por la versi@'on de WeeChat en la cadena)@* -Typo: cadena (cualquier cadena), valor por defecto: 'WeeChat %v'@* -@item irc_notice_as_pv -Mostrar noticias como mensajes privados@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item irc_away_check -Intervalo entre dos comprobaciones de ausencia (en minutos, 0 = no comprobar)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 0@* -@item irc_lag_check -Intervalo entre dos medidas de lag (en segundos)@* -Typo: entero (valores: entre 30 y 2147483647), valor por defecto: 60@* -@item irc_lag_min_show -Lag m@'inimo a mostrar (en segundos)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 1@* -@item irc_lag_disconnect -Desconexi@'on tras un lag importante (en minutos, 0 = no desconectar nunca)@* -Typo: entero (valores: entre 0 y 2147483647), valor por defecto: 5@* -@item irc_fifo_pipe -Crea una tuber@'ia FIFO para control remoto@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item irc_highlight -Lista separada por comas de palabras a resaltar (comparaci@'on insensible a mayúsculas, las palabras pueden empezar o terminar con "*" para una concordancia parcial)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item irc_colors_receive -Cuando se desactiva, los c@'odigos de color se ignoran en los mensajes entrantes@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item irc_colors_send -Permitir al usuario enviar colores con c@'odigos especiales (%B=negrita, %Cxx,yy=color, %U=subrayado, %R=invertido) @* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item dcc_auto_accept_files -Aceptar autom@'aticamente los ficheros dcc entrantes@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item dcc_auto_accept_chats -Aceptar autom@'aticamente las peticiones de conversaci@'on dcc (¡utilizar con precauci@'on!)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item dcc_timeout -Tiempo de espera para la petici@'on dcc (en segundos)@* -Typo: entero (valores: entre 1 y 2147483647), valor por defecto: 300@* -@item dcc_blocksize -Tama@~no de bloque para los paquetes dcc en bytes (por defecto: 65536)@* -Typo: entero (valores: entre 1024 y 102400), valor por defecto: 65536@* -@item dcc_port_range -Restringe el dcc de salida a utilizar únicamente los puertos del rango especificado (útil para NAT) (sintaxis: un puerto simple, e.g. 5000, o un rango de puertos, e.g. 5000-5015, un valor vac@'io significa cualquier puerto)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item dcc_own_ip -Direcci@'on IP o DNS usado para dcc de salida (si est@'a vac@'io, se utiliza la IP de interfaz local)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item dcc_download_path -Ruta para los ficheros recibidos con dcc (por defecto: directorio home del usuario)@* -Typo: cadena (cualquier cadena), valor por defecto: '~'@* -@item dcc_upload_path -Ruta para la lectura de ficheros cuando se env@'ian a trav@'es de dcc (cuando no se especifica una ruta)@* -Typo: cadena (cualquier cadena), valor por defecto: '~'@* -@item dcc_convert_spaces -Convertir los espacios a subrayados cuando se env@'ian los ficheros@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item dcc_auto_rename -Renombrar los ficheros recibidos si ya existen (a@~nadir '.1', '.2', ...)@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item dcc_auto_resume -Continuar autom@'aticamente la transferencia dcc si se ha perdido la conexi@'on con la m@'aquina remota@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item proxy_use -Utilizar un proxy para conectarse al servidor irc@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item proxy_type -Tipo de proxy(http (por defecto), socks4, socks5)@* -Typo: cadena (valores: 'http', 'socks4', 'socks5'), valor por defecto: 'http'@* -@item proxy_ipv6 -Conectar al proxy en ipv6@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item proxy_address -Direcci@'on del servidor proxy (IP o nombre de m@'aquina)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item proxy_port -Puerto para conectarse al servidor proxy@* -Typo: entero (valores: entre 0 y 65535), valor por defecto: 3128@* -@item proxy_username -Nombre de usuario para el servidor proxy@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item proxy_password -Contrase@~na para el servidor proxy@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item plugins_path -Ruta para la búsqueda de plugins@* -Typo: cadena (cualquier cadena), valor por defecto: '~/.weechat/plugins'@* -@item plugins_autoload -Lista de plugins separados por comas para cargar autom@'aticamente al iniciar, "*" significa todos los plugins encontrados (los nombres pueden ser parciales, por ejemplo "perl" est@'a bien para "libperl.so")@* -Typo: cadena (cualquier cadena), valor por defecto: '*'@* -@item plugins_extension -Extensi@'on de plugins est@'andar en nombre de archivo, usada para la autocarga (si est@'a vac@'io, entonces se cargan todos los archivos cuando la autocarga es "*")@* -Typo: cadena (cualquier cadena), valor por defecto: '.so'@* -@item server_name -Nombre asociado al servidor IRC (para mostrar solamente)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_autoconnect -Conexi@'on autom@'atica al servidor cuando WeeChat est@'a arrancando@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item server_autoreconnect -Reconexi@'on autom@'atica al servidor tras una desconexi@'on@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item server_autoreconnect_delay -Espera (en segundos) antes de intentar de nuevo una reconexi@'on al servidor@* -Typo: entero (valores: entre 0 y 65535), valor por defecto: 30@* -@item server_address -Direcci@'on IP o nombre de m@'aquina del servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_port -Puerto para conectarse al servidor@* -Typo: entero (valores: entre 0 y 65535), valor por defecto: 6667@* -@item server_ipv6 -Usar el protocolo IPv6 para la comunicaci@'on del servidor@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item server_ssl -Usar SSL para la comunicaci@'on del servidor@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'off'@* -@item server_password -Contrase@~na para el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_nick1 -Nombre de usuario a utilizar en el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_nick2 -Nombre de usuario alternativo para el servidor IRC (si el nombre de usuario ya est@'a en uso)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_nick3 -Segundo nombre de usuario alternativo a utilizar en el servidor IRC (si el nombre de usuario alternativo ya est@'a en uso)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_username -Nombre de usuario para el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_realname -Nombre real para el servidor IRC@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_command -Primer comando a ejecutar cuando se conecte a un servidor@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_command_delay -Espera (en segundos) despu@'es de que el comando sea ejecutado (ejemplo: dar algo de tiempo para la autenticaci@'on)@* -Typo: entero (valores: entre 0 y 5), valor por defecto: 0@* -@item server_autojoin -Lista de canales (separados por comas) a unirse cuando se conecte a un servidor (ejemplo: "#chan1,#chan2,#chan3 key1,key2")@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_autorejoin -Unirse de nuevo autom@'aticamente a los canales cuando sea expulsado@* -Typo: booleano (valores: 'on' u 'off'), valor por defecto: 'on'@* -@item server_notify_levels -Lista separada por comas de niveles de notificaci@'on para canales de este servidor (formato: #canal:1,...)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_charset_decode_iso -Comma separated list of charsets for server and channels, to decode ISO (format: server:charset,#channel:charset,..)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_charset_decode_utf -Comma separated list of charsets for server and channels, to decode UTF (format: server:charset,#channel:charset,..)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@item server_charset_encode -Comma separated list of charsets for server and channels, to encode messages (format: server:charset,#channel:charset,..)@* -Typo: cadena (cualquier cadena), valor por defecto: ''@* -@end table - -Los colores para el interfaz Curses son:@* -@itemize @minus -@item -@kbd{default}: color por defecto (con transparencia para el fondo) -@item -@kbd{black}: negro -@item -@kbd{red}: rojo oscuro -@item -@kbd{lightred}: rojo claro -@item -@kbd{green}: verde oscuro -@item -@kbd{lightgreen}: verde claro -@item -@kbd{brown}: marr@'on -@item -@kbd{yellow}: amarillo -@item -@kbd{blue}: azul oscuro -@item -@kbd{lightblue}: azul claro -@item -@kbd{magenta}: violeta oscuro -@item -@kbd{lightmagenta}: violeta claro -@item -@kbd{cyan}: cyan oscuro -@item -@kbd{lightcyan}: cyan claro -@item -@kbd{white}: blanco -@end itemize - -@node Atajos de teclado, Comandos WeeChat, Ficheros de configuracion, Uso -@section Atajos de teclado - -@table @kbd -@item Flecha izquierda / Flecha derecha -Ir a la letra anterior / siguiente en la l@'inea de comandos@* -@* -@item Ctrl + flecha izquierda / Ctrl + flecha derecha -Ir a la palabra anterior / siguiente en la l@'inea de comandos@* -@* -@item Inicio / Ctrl + A -Ir al inicio de la l@'inea de comandos@* -@* -@item Fin / Ctrl + E -Ir al final de la l@'inea de comandos@* -@* -@item Ctrl + K -Delete until end of line@* -@* -@item Ctrl + L -Refrescar toda la ventana@* -@* -@item Ctrl + U -Delete until beginning of line@* -@* -@item Ctrl + W -Borrar la palabra anterior en la l@'inea de comandos@* -@* -@item Backspace / Supr -Borrar el caracter anterior / siguiente en la l@'inea de comandos@* -@* -@item Tab -Completar el comando o el seud@'onimo (@kbd{Tab} de nuevo: encontrar la pr@'oxima autocompletaci@'on)@* -@* -@item Cualquier caracter -A@~nadir la letra en la posici@'on del cursor en la l@'inea de comandos@* -@* -@item Entrar -Ejecutar la l@'inea de comandos o enviar el mensaje@* -@* -@item Flecha de arriba / Flecha de abajo -Mostrar los @'ultimos comandos/mensajes@* -@* -@item Ctrl + up arrow / Ctrl + down arrow -Call again last commands/messages in global history@* -@* -@item PageUp / PageDown -Obtener el hist@'orico de la memoria temporal (buffer)@* -@* -@item F5 / F6 -Ir a la memoria temporal anterior / siguiente@* -@* -@item F7 / F8 -Ir a la ventana anterior / siguiente@* -@* -@item F10 -Borrar el @'ultimo mensaje en la barra de informaciones@* -@* -@item F11 / F12 -Scroll nicklist@* -@* -@item Alt + flecha izquierda / Alt + flecha derecha -Como F5 / F6@* -@* -@item Alt + A -Ir a la memoria temporal donde hay actividad (con el orden de prioridad siguiente: resaltado, mensaje, otros)@* -@* -@item Alt + B -Go to previous word@* -@* -@item Alt + D -Delete next word@* -@* -@item Alt + F -Go to next word@* -@* -@item Alt + H -Borrar la 'hotlist' (notificaci@'on de actividad en otras memorias temporales)@* -@* -@item Alt + J then Alt + D -Obtener la lista de DCC actual@* -@* -@item Alt + J then Alt + L -Switch to last buffer@* -@* -@item Alt + J then Alt + S -Ir a la memoria temporal del servidor@* -@* -@item Alt + J then Alt + X -Ir al primer canal del servidor siguiente (o a la memoria temporal del servidor si ning@'un canal est@'a abierto)@* -@* -@item Alt + (1-9) -Saltar a la memoria temporal con ese n@'umero@* -@* -@item Alt + J then number (01-99) -Saltar a la memoria temporal con ese n@'umero@* -@* -@item Alt + K -Grab a key -@* -@item Alt + N -Scroll to next highlight@* -@* -@item Alt + P -Scroll to previous highlight@* -@* -@item Alt + R -Delete entire line@* -@* -@item Alt + S -Switch server on servers buffer@* -(if option ``look_one_server_buffer'' is enabled)@* -@* -@item Alt + U -Scroll to first unread line in buffer@* -@* -@item Alt + W then Alt + arrow -Switch to window with direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Scroll nicklist@* -@* -@end table - -@node Comandos WeeChat, Canal FIFO, Atajos de teclado, Uso -@section Comandos WeeChat - -Comandos internos WeeChat:@* - -@table @kbd -@item alias [alias_name [command [arguments]] -@* -create an alias for a command@* -@* -alias_name: name of alias@* -command: command name (WeeChat or IRC command, without first '/')@* -arguments: arguments for command@* -@* -@item buffer [action | number | [[server] [channel]]] -@* -manage buffers@* -@* -action: action to do:@* - move: move buffer in the list (may be relative, for example -1)@* - close: close buffer (for channel: same as /part without part message)@* - list: list opened buffers (no parameter implies this list)@* - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)@* -server,channel: jump to buffer by server and/or channel name@* -number: jump to buffer by number@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -change charset for server or channel@* -@* -decode_iso: charset used for decoding ISO@* -decode_utf: charset used for decoding UTF@* - encode: charset used for encoding messages@* - charset: charset to use (for example: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -clear window(s)@* -@* --all: clear all windows@* -@* -@item connect [servername] -@* -connect to a server@* -@* -servername: server name to connect@* -@* -@item disconnect [servername] -@* -disconnect from a server@* -@* -servername: server name to disconnect@* -@* -@item debug dump | windows -@* -print debug messages@* -@* -dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)@* -windows: display windows tree@* -@* -@item help [command] -@* -display help about commands@* -@* -command: name of a WeeChat or IRC command@* -@* -@item history [clear | value] -@* -show buffer command history@* -@* -clear: clear history@* -value: number of history entries to show@* -@* -@item ignore [mask [[type | command] [channel [server]]]] -@* -ignore IRC messages and/or hosts@* -@* - mask: nick or host mask to ignore@* - type: type of message to ignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for ignore@* - server: name of server for ignore@* -@* -For each argument, '*' means all.@* -Without argument, /ignore command lists all defined ignore.@* -@* -@item key [key function/command] [unbind key] [functions] [reset -yes] -@* -bind/unbind keys@* -@* -key: bind this key to an internal function or a command (beginning by "/")@* -unbind: unbind a key (if "all", default bindings are restored)@* -functions: list internal functions for key bindings@* -reset: restore bindings to the default values and delete ALL personal binding (use carefully!)@* -@* -@item plugin [load filename] | [autoload] | [reload] | [unload] -@* -list/load/unload plugins@* -@* -filename: WeeChat plugin (file) to load@* -@* -Without argument, /plugin command lists all loaded plugins.@* -@* -@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] -@* -list, add or remove servers@* -@* -servername: server name, for internal & display use@* -hostname: name or IP address of server@* -port: port for server (integer)@* -ipv6: use IPv6 protocol@* -ssl: use SSL protocol@* -password: password for server@* -nick1: first nick for server@* -nick2: alternate nick for server@* -nick3: second alternate nick for server@* -username: user name@* -realname: real name of user@* -@* -@item save [file] -@* -save config to disk@* -@* -file: filename for writing config@* -@* -@item set [option [ = value]] -@* -set config parameters@* -@* -option: name of an option (if name is full and no value is given, then help is displayed on option)@* -value: value for option@* -@* -@item unalias alias_name -@* -remove an alias@* -@* -alias_name: name of alias to remove@* -@* -@item unignore [number | [mask [[type | command] [channel [server]]]]] -@* -unignore IRC messages and/or hosts@* -@* - number: # of ignore to unignore (number is displayed by list of ignore)@* - mask: nick or host mask to unignore@* - type: type of message to unignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for unignore@* - server: name of server for unignore@* -@* -For each argument, '*' means all.@* -Without argument, /unignore command lists all defined ignore.@* -@* -@item upgrade -@* -upgrade WeeChat without disconnecting from servers@* -@* -@item uptime [-o] -@* -show WeeChat uptime@* -@* --o: send uptime on current channel as an IRC message@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]] -@* -manage windows@* -@* -list: list opened windows (no parameter implies this list)@* --1: jump to previous window@* -+1: jump to next window@* -b#: jump to next window displaying buffer number #@* -up: switch to window above current one@* -down: switch to window below current one@* -left: switch to window on the left@* -right: switch to window on the right@* -splith: split current window horizontally@* -splitv: split current window vertically@* -resize: resize window size, new size is <pct>%% of parent window@* -merge: merge window with another (all = keep only one window)@* -@* -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4@* -@* -@end table - -Comandos IRC:@* - -@table @kbd -@item admin [target] -@* -encontrar informaci@'on sobre el administrador del servidor@* -@* -target: servidor objetivo@* -@* -@item ame mensaje -@* -send a CTCP action to all channels of all connected servers@* -@* -mensaje: mensaje a enviar@* -@* -@item amsg texto -@* -send message to all channels of all connected servers@* -@* -texto: texto a enviar@* -@* -@item away [-all] [mensaje] -@* -revertir el estado ausente@* -@* --all: revertir el estado ausente en todos los servidores conectados@* -mensaje: mensaje para el estado ausente (si no se da ningún mensaje, se elimina el estado ausente)@* -@* -@item ban [canal] [usariio [usuario ...]] -@* -banea usuarios o m@'aquinas@* -@* -canal: canal en el que banear@* -usuario: nombre de usuario o m@'aquina a banear@* -@* -@item ctcp nickname type [arguments] -@* -send a CTCP message (Client-To-Client Protocol)@* -@* -nickname: user to send CTCP to@* -type: CTCP type (examples: "version", "ping", ..)@* -arguments: arguments for CTCP@* -@* -@item dcc acci@'on [usuario [fichero]] -@* -empieza DCC (archivo @'o charla) @'o cerrar charla@* -@* -acci@'on: 'send' (env@'io de archivo) @'o 'chat' (charla) @'o 'close' (cerrar charla)@* -usuario: nombre de usuario a quien enviar el archivo o la charla@* -fichero: nombre del fichero (en la m@'aquina local)@* -@* -@item dehalfop [pseudo [pseudo]] -@* -elimina el estado de media operador de canal a/a los usuario(s)@* -@* -@item deop [pseudo [pseudo]] -@* -elimina el estado de operador de canal a/a los usuario(s)@* -@* -@item devoice [pseudo [pseudo]] -@* -elimina la voz a/a los usuario(s)@* -@* -@item die -@* -cerrar el servidor@* -@* -@item halfop [pseudo [pseudo]] -@* -dar el estado de media operador de canal a/a los usuario(s)@* -@* -@item info [target] -@* -obtener informaci@'on describiendo al servidor@* -@* -objetivo: nombre del servidor@* -@* -@item invite usuario canal -@* -invitar a un usuario a un canal@* -@* -nickname: usuario a invitar@* -channel: canal para la invitaci@'on@* -@* -@item ison usuario [usuario ...] -@* -comprobar si un usuario est@'a actualmente en el IRC@* -@* -usuario: usuario@* -@* -@item join canal[,canal] [clave[,clave]] -@* -unirse a un canal@* -@* -canal: nombre del canal al que unirse@* -clave: clave para unirse al canal@* -@* -@item kick [canal] usuario [comentario] -@* -expulsar forzosamente a un usuario de un canal@* -@* -canal: canal en el que est@'a el usuario@* -usuario: usuario a expulsar@* -comentario: comentario para la expulsi@'on@* -@* -@item kickban [canal] usuario [comentario] -@* -expulsa y banea a un usuario de un canal@* -@* -canal: canal donde est@'a el usuario@* -usuario: nombre de usuario a expulsar y banear@* -comentario: comentario para la expulsi@'on@* -@* -@item kill usuario comentario -@* -cerrar la conexi@'on cliente-servidor@* -@* -usuario: usuario@* -comentario: comentario para la muerte@* -@* -@item links [[servidor] m@'ascara_servidor] -@* -listar todos los nombres de servidor conocidos por el servidor que responde a la consulta@* -@* -servidor: este servidor deber@'ia responder a la consulta@* -m@'ascara_servidor: listado de servidores que deben coincidir con esta m@'ascara@* -@* -@item list [canal[,canal] [servidor]] -@* -listar canales y sus temas@* -@* -canal: canal a listar@* -servidor: nombre del servidor@* -@* -@item lusers [m@'ascara [objetivo]] -@* -obtener estad@'isticas sobre el tama@~no de la red IRC@* -@* -m@'ascara: servidores que coinciden s@'olo con la m@'ascara@* -objetivo: servidor al que remitir la consulta@* -@* -@item me mensaje -@* -enviar una acci@'on CTCP al canal actual@* -@* -mensaje: mensaje a enviar@* -@* -@item mode @{ canal @{[+|-]|o|p|s|i|t|n|b|v@} [limitar] [usuario] [m@'ascara de baneo] @} | @{ usuario @{[+|-]|i|w|s|o@} @} -@* -cambiar modo del canal o del usuario@* -@* -channel modes:@* - channel: channel name to modify@* - o: give/take channel operator privileges@* - p: private channel flag@* - s: secret channel flag@* - i: invite-only channel flag@* - t: topic settable by channel operator only flag@* - n: no messages to channel from clients on the outside@* - m: moderated channel@* - l: set the user limit to channel@* - b: set a ban mask to keep users out@* - e: set exception mask@* - v: give/take the ability to speak on a moderated channel@* - k: set a channel key (password)@* -user modes:@* - nickname: nickname to modify@* - i: mark a user as invisible@* - s: mark a user for receive server notices@* - w: user receives wallops@* - o: operator flag@* -@* -@item motd [target] -@* -obtener el mensaje del d@'ia@* -@* -objetivo: nombre del servidor@* -@* -@item msg destinatario[,destinatario] texto -@* -enviar un mensaje a un usuario o canal@* -@* -destinatario: usuario o canal (puede que sea una m@'ascara, '*' = canal actual)@* -texto: texto a enviar@* -@* -@item names [canal[,canal]] -@* -listar usuarios en canales@* -@* -canal: nombre del canal@* -@* -@item nick [-all] usuarios -@* -cambiar el nombre de usuario actual@* -@* --all: establece el nuevo nombre de usuario para todos los servidores conectados@* -nickname: nuevo nombre de usuario@* -@* -@item notice usuario texto -@* -enviar mensaje de aviso a usuario@* -@* -usuario: usuario destinatario del aviso@* -texto: texto a enviar@* -@* -@item op pseudo [pseudo] -@* -dar el estado de operador de canal a/a los usuario(s)@* -@* -@item oper contrase@~na de usuario -@* -obtener el estado de operador@* -@* -usuario/contrase@~na: usado para obtener los privilegios en el servidor IRC actual@* -@* -@item part [canal[,canal]] [mensaje_de_salida] -@* -abandonar un canal@* -@* -canal: canal a abandonar@* -mensaje de salida: mensaje de partida (mostrado al resto de usuarios)@* -@* -@item ping servidor1 [servidor2] -@* -hacer ping a un servidor@* -@* -servidor1: servidor al que hacer ping@* -servidor2: remitir el ping a este servidor@* -@* -@item pong demonio [demonio2] -@* -contestar a un mensaje de ping@* -@* -demonio: demonio que ha contestado al mensaje Ping@* -d@'emon2: remitir el mensaje a este demonio@* -@* -@item query usuario [texto] -@* -enviar un mensaje privado a un usuario@* -@* -usuario: usuario para conversaci@'on privada@* -texto: texto a enviar@* -@* -@item quit [mensaje_de_salida] -@* -cerrar todas las conexiones y salir@* -@* -mensaje_de_salida: mensaje de partida (mostrado al resto de usuarios)@* -@* -@item quote datos -@* -enviar datos en sucio al servidor sin analizar@* -@* -datos: datos en sucio a enviar@* -@* -@item rehash -@* -pedir al servidor que recarque su archivo de configuraci@'on@* -@* -@item restart -@* -pedir al servidor que se reinicie@* -@* -@item service usuario reservado distribuci@'on tipo reservado info -@* -registrar un nuevo servicio@* -@* -distribuci@'on: visibilidad del servicio@* -tipo: reservado para una futura utilizaci@'on@* -@* -@item servlist [m@'ascara [tipo]] -@* -listar servicios conectados actualmente a la red@* -@* -m@'ascara: listar s@'olo aquellos servicios que concuerdan con esta m@'ascara@* -tipo: listar s@'olo servicios de este tipo@* -@* -@item squery servicio texto -@* -enviar un mensaje a un servicio@* -@* -servicio: nombre del servicio@* -texto: texto a enviar@* -@* -@item squit comentario de servidor -@* -desconectar los enlaces de servidor@* -@* -servidor: nombre del servidor@* -comentario: comentario para salir@* -@* -@item stats [consulta [servidor]] -@* -pedir estad@'isticas sobre el servidor@* -@* -consulta: c/h/i/k/l/m/o/y/u (ver la RFC1459)@* -servidor: nombre del servidor@* -@* -@item summon usuario [destinatario [canal]] -@* -enviar a los usuarios que est@'an en una m@'aquina local ejecutando un servidor IRC un mensaje pidi@'endoles que se unan al IRC@* -@* -usuario: nombre de usuario@* -destinatario: nombre del servidor@* -canal: nombre del canal@* -@* -@item time [target] -@* -pedir la hora local del servidor@* -@* -destinatario: pedir la hora de ese servidor@* -@* -@item topic [canal] [tema] -@* -obtener/establecer el tema de un canal@* -@* -canal: nombre del canal@* -tema: nuevo tema para el canal (si el tema es "-delete" entonces se elimina el tema actual)@* -@* -@item trace [target] -@* -encontrar la ruta hacia el servidor especificado@* -@* -target: servidor objetivo@* -@* -@item unban [canal] usuario [usuario ...] -@* -desbanea usuarios o m@'aquinas@* -@* -canal: canal en el que desbanear (quitar la prohibici@'on)@* -usuario: usuario o m@'aquina a desbanear@* -@* -@item userhost usuario [usuario ...] -@* -devuelve una lista de informaci@'on sobre usuarios@* -@* -usuario: usuario@* -@* -@item users [target] -@* -lista de usuarios conectados al servidor@* -@* -target: servidor objetivo@* -@* -@item version [servidor | usuario] -@* -da la informaci@'on de versi@'on del usuario o servidor (actual o especificado)@* -@* -servidor: nombre de servidor@* -usuario: usuario@* -@* -@item voice [pseudo [pseudo]] -@* -da voz a/a los usuario(s)@* -@* -@item wallops texto -@* -enviar un mensaje a todos los usuarios conectados que tengan activo el modo de usuario w para ellos mismos@* -@* -texto a enviar@* -@* -@item who [m@'ascara ["o"]] -@* -genera una consulta que devuelve una lista de informaci@'on@* -@* -m@'ascara: s@'olo informaci@'on que concuerde con esta m@'ascara@* -o: s@'olo son devueltos operadores de acuerdo con la m@'ascara proporcionada@* -@* -@item whois [servidor] usuario[,usuario] -@* -pedir informaci@'on sobre el/los usuario(s)@* -@* -servidor: nombre del servidor@* -usuario: nombre de usuario (puede que sea una m@'ascara)@* -@* -@item whowas usuario [,usuario [,usuario ...]] [número [destinatario]] -@* -pedir informaci@'on sobre un usuario que ya no existe@* -@* -usuario: nombre de usuario a buscar@* -número: número de respuestas a devolver (búsqueda completa si el número es negativo)@* -destinatario: la respuesta deber@'ia concordar con esta m@'ascara@* -@* -@end table - -Internal functions for keys:@* - -@table @kbd -@item return -terminate line@* -@item tab -complete word@* -@item backspace -delete previous char@* -@item delete -delete next char@* -@item delete_end_line -delete until end of line@* -@item delete_beginning_line -delete until beginning of line@* -@item delete_line -delete entire line@* -@item delete_previous_word -delete previous word@* -@item delete_next_word -delete next word@* -@item clipboard_paste -paste current clipboard content@* -@item transpose_chars -transpose chars@* -@item home -go to beginning of line@* -@item end -go to end of line@* -@item left -move one char left@* -@item previous_word -move to previous word@* -@item right -move one char right@* -@item next_word -move to next word@* -@item up -call previous command in history@* -@item up_global -call previous command in global history@* -@item down -call next command in history@* -@item down_global -call next command in global history@* -@item page_up -scroll one page up@* -@item page_down -scroll one page down@* -@item nick_beginning -display beginning of nicklist@* -@item nick_end -display end of nicklist@* -@item nick_page_up -scroll nicklist one page up@* -@item nick_page_down -scroll nicklist one page down@* -@item jump_smart -jump to buffer with activity@* -@item jump_dcc -jump to DCC buffer@* -@item jump_last_buffer -jump to last buffer@* -@item jump_server -jump to server buffer@* -@item jump_next_server -jump to next server@* -@item switch_server -switch active server on servers buffer@* -@item scroll_previous_highlight -scroll to previous highlight in buffer@* -@item scroll_next_highlight -scroll to next highlight in buffer@* -@item scroll_unread -scroll to first unread line in buffer@* -@item hotlist_clear -clear hotlist@* -@item infobar_clear -clear infobar@* -@item refresh -refresh screen@* -@item grab_key -grab a key@* -@end table - -@node Canal FIFO, , Comandos WeeChat, Uso -@section Canal FIFO - -Puedes controlar WeeChat a distantia, enviando comandos o texto a un canal FIFO -(debes activar la opci@'on "irc_fifo_pipe" que est@'a desactivada por defecto).@* -El canal FIFO est@'a dentro del directorio ~/.weechat/ y se llama -"weechat_fifo_xxxxx" (donde xxxxx es el ID del proceso (PID) de WeeChat).@* -Entonces si tienes varios WeeChat que se est@'an ejecutando, tendr@'as varios -canales FIFO, uno por cada sesi@'on.@* -@* -La sintaxis para enviar comandos o texto dentro del canal FIFO es la siguiente:@* -@command{servidor,canal *texto o comando aqu@'i}@* -donde el serviros y el canal son opcionales pero si precisa el canal, debes -precisar tambi@'en el servidor.@* -@* -Algunos ejemplos: -@table @asis -@item @bullet{} cambiar el seud@'onimo en freenode por "mynick|out": -@* -@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} escribir texto en el canal #weechat: -@* -@command{echo "freenode,#weechat *@exclamdown{}Hola a todos!" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} escribir texto en el canal corriente (el que se puede visualizar en WeeChat actualmente) -@* -@command{echo "*@exclamdown{}Hola!" >~/.weechat/weechat_fifo_12345} -@* -@b{Advertencia:} esto es peligroso y no deber@'ias hacerlo.. salvo si lo que est@'as haciendo. -@* -@item @bullet{} enviar dos comandos para descargar y recargar los scripts Perl (tienes que separarlos con un \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -Puedes escribir un script que envia los comandos a todos los programas WeeChat -que se est@'an ejecutando de momento. Por ejemplo:@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -Si el script se llama "auto_weechat_command", puedes ejecutarlo hac@'i:@* -@command{./auto_weechat_command "freenode,#weechat *Hola"} - - -@c ******************************** Plugins *********************************** - -@node Plugins, Autores / Soporte, Uso, Top -@chapter Plugins - -@menu -* Plugins in WeeChat:: -* Write a plugin:: -* Plugin example:: -* Scripts plugins:: -@end menu - -@node Plugins in WeeChat, Write a plugin, Plugins, Plugins -@section Plugins in WeeChat - -A plugin is a C program which can call WeeChat functions defined in an -interface.@* -@* -This C program does not need WeeChat sources to compile and can be -dynamically loaded into WeeChat with command @command{/plugin}.@* -@* -The plugin has to be a dynamic library, for dynamic loading by -operating system. -Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under -Windows. - -@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins -@section Write a plugin - -@subsection Base rules - -The plugin should include ``weechat-plugin.h'' file (available in -WeeChat source code).@* -This file defines structures and types used to communicate with WeeChat.@* -@* -The plugin must have some variables and functions (mandatory, without -them the plugin can't load):@* -@itemize @bullet -@item variables for plugin description: -@itemize @minus -@item plugin_name[]: plugin name -@item plugin_version[]: plugin version -@item plugin_description[]: short description of plugin -@end itemize -@item functions for init and end of plugin: -@itemize @minus -@item weechat_plugin_init: function called when plugin is loaded, -must return PLUGIN_RC_OK (0) if successful, PLUGIN_RC_KO (-1) if error -@item weechat_plugin_end: function called when plugin is unloaded -@end itemize -@end itemize - -@subsection API functions - -The plugin can call some functions defined in t_weechat_plugin -structure.@* -@* -These functions are detailed below:@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Locale and case independent string comparison.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Locale and case independent string comparison, for ``max'' chars.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@item @option{max}: max number of chars for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explode a string according to one or more delimiter(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string to explode -@item @option{separators}: delimiters used for explosion -@item @option{num_items_max}: maximum number of items created (0 means -no limit) -@item @option{num_items}: pointer to int which will contain number of -items created -@end itemize -@* -@emph{Return value:}@* -@* -Array of strings, NULL if problem.@* -Note: the result has to be free by a call to ``free_exploded_string'' -function after use.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Free memory used by a string explosion.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string exploded by ``explode_string'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Execute a function on all files of a directory.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{directory}: directory for searching files -@item @option{callback}: function called for each file found -@end itemize -@* -@emph{Return value:}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "file: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Display a message on a WeeChat buffer, identified by server and -channel (both may be NULL for current buffer).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server to find buffer for message -display (may be NULL) -@item @option{channel}: name of channel to find buffer for message -display (may be NULL) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Display a message on server buffer.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Display a message in infobar for a specified time.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{time}: time in seconds for displaying message (0 means -never erased) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Add an IRC message handler, called when an IRC message is received.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: IRC message (for example: ``PRIVMSG'') -@item @option{handler_func}: function called when message is received -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new message handler.@* -@* -@emph{Example:}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK received");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to -WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to -other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Add a WeeChat command handler, called when user uses command -(for example /command).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{command}: the new command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@item @option{handler_func}: function called when comand is executed -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new command handler.@* -@* -@emph{Example:}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "test command, -file: %s", (arguments) ? arguments : "none");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Test command", -"[file]", "file: a file name", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Remove a handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{handler}: handler to remove -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Remove all handlers for a plugin.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute a WeeChat command (or send a message to a channel).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server for executing command (may be -NULL) -@item @option{channel}: name of channel for executing command (may be -NULL) -@item @option{command}: command -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Return an info about WeeChat or a channel.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{info}: name of info to read: -@itemize @minus -@item @option{version}: get WeeChat's version -@item @option{nick}: get nick -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir -@end itemize -@item @option{server}: name of server for reading info (if needed) -@end itemize -@* -@emph{Return value:}@* -@* -Information asked, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Returns list of DCC currently active or finished.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -Chained list of DCC.@* -Note: result has to be free by a call to ``free_dcc_info'' function -after use.@* -@* -@emph{Example:}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, with: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Free memory used by a DCC list.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{dcc_info}: pointer to DCC list returned by -``get_dcc_info'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Example:}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "my_var");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_plugin_config (plugin, "my_var", "value");}@* -@* - -@end itemize - -@subsection Compile plugin - -Compile does not need WeeChat sources, only file -``weechat-plugin.h''.@* - -To compile a plugin which has one file ``toto.c'' (sous GNU/Linux):@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Load plugin under WeeChat - -Copy ``libtoto.so'' file into general plugins dir (for example -/usr/local/lib/weechat/plugins) or into user's plugins dir (for -example /home/xxxxx/.weechat/plugins).@* -@* -Under WeeChat:@* -@command{/plugin load toto} - -@node Plugin example, Scripts plugins, Write a plugin, Plugins -@section Plugin example - -Full example of plugin, which adds a /double command, which displays -two times arguments on current channel (ok that's not very useful, but -that's just an example!):@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/hello" command handler */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -@end verbatim - -@node Scripts plugins, , Plugin example, Plugins -@section Scripts plugins - -Three plugins are provided with WeeChat to load scripts: Perl, -Python and Ruby. - -@subsection Load/unload scripts - -Perl scripts are loaded and unloaded with @command{/perl}, -@command{/python} and @command{/ruby} commands. -(type @kbd{/help} within WeeChat to get help about commands).@* - -@emph{Examples:}@* -@itemize @bullet -@item -Load a Perl script: @kbd{/perl load /tmp/sample.pl}@* -@item -Unload all Perl scripts: @kbd{/perl unload}@* -@item -List all Perl scripts: @kbd{/perl}@* -@item -Load a Python script: @kbd{/python load /tmp/sample.py}@* -@item -Unload all Python scripts: @kbd{/python unload}@* -@item -List all Python scripts: @kbd{/python}@* -@end itemize - -@subsection WeeChat / Scripts API - -@itemize @bullet -@item -Perl: @command{weechat::register ( name, version, shutdown_function, -description );}@* -Python: @command{weechat.register ( name, version, shutdown_function, -description )}@* -@* -This is first function to call in script.@* -All 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}: 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{Return value:}@* -@* -1 if script was registered, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::register ("sample", "1.0", "sample_end", "Sample -script!");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.register ("sample", "1.0", "sample_end", "Sample -script!")}@* -@* - -@item -Perl: @command{weechat::print ( message, [channel, [server]] );}@* -Python: @command{weechat.prnt ( message, [channel, [server]] )}@* -@* -Print message in a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{message}: message to display -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( delay, message );}@* -Python: @command{weechat.print_infobar ( delay, message )}@* -@* -Print message in infobar.@* - -@emph{Arguments:} -@itemize @minus -@item @option{delay}: after this delay (in seconds), message will be erased -(if 0, message will not be erased). -@item @option{message}: message to display -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( name, function );}@* -Python: @command{weechat.add_message_handler ( name, function )}@* -@* -Attach a script 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}: function called when message is received -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_message_handler ("privmsg", my_function);}@* -@code{sub my_function}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("server=$_[0]\n");}@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* -@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_message_handler ("privmsg", my_function)}@* -@code{def my_function(server, args):}@* -@code{@ @ @ @ weechat.prnt("server="+server)}@* -@code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent -to WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent -to other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Create new WeeChat command, linked with script 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 -script function. Be careful when overriding WeeChat commands, they'll not be -available until your script will be unloaded. -@item @option{function}: function linked with command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_command_handler ("command", my_command);}@* -@code{sub my_command}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_command_handler ("command", my_command)}@* -@code{def my_command(server, args):}@* -@code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( name, function );}@* -Python: @command{weechat.remove_handler ( name, function )}@* -@* -Remove a message or command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of IRC message or command handler -@item @option{function}: function -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::remove_handler ("command", my_command);}@* -@* -@emph{Python example:}@* -@* -@code{weechat.remove_handler ("command", my_command)}@* -@* - -@item -Perl: @command{weechat::command ( command, [channel, [server]] );}@* -Python: @command{weechat.command ( command, [channel, [server]] )}@* -@* -Execute a command or send a message to a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{command}: command to execute (or message to send in a channel) -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::command ("hello world!");}@* -@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.command ("hello world!")}@* -@code{weechat.command ("/kick toto please leave this chan", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( name, [server] );}@* -Python: @command{weechat.get_info ( name, [server] )}@* -@* -Get various info about WeeChat, server or user.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of info to retrieve: -@itemize @minus -@item @option{version}: get WeeChat version -@item @option{nick}: get nickname -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir - -@end itemize -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -Asked info, empty if error occured or info was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$version = weechat::get_info("version");}@* -@code{$nick = weechat::get_info("nick", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{$version = weechat.get_info("version")}@* -@code{$nick = weechat.get_info("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( );}@* -@* -Get DCC list.@* - -Returned array has following fields: -@itemize @minus -@item server: IRC server -@item channel: IRC channel -@item type: DCC type: -@itemize @minus -@item 0: chat (received) -@item 1: chat (sent) -@item 2: file (receiving) -@item 3: file (sending) -@end itemize -@item status: DCC status: -@itemize @minus -@item 0: waiting -@item 1: connecting -@item 2: active -@item 3: done -@item 4: failed -@item 5: aborted -@end itemize -@item start_time: date/time of DCC creation -@item start_transfer: date/time of transfer start -@item addr: remote address -@item port: port used for DCC -@item nick: remote nick -@item filename: filename -@item local_filename: local filename -@item size: file size -@item pos: current position in file -@item start_resume: restart position after interruption -@item bytes_per_sec: bytes sent/received per second -@end itemize -@* -@emph{Return value:}@* -@* -DCC list, 0 if error occured.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Python examples:}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, value );}@* -Python: @command{weechat.set_config ( option, value )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin"", -"#weechat");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl example:}@* -@* -@code{$value = weechat::get_plugin_config ("my_var");}@* -@* -@emph{Python example:}@* -@* -@code{$value = weechat.get_plugin_config ("my_var")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, value );}@* -Python: @command{weechat.set_plugin_config ( option, value )}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::set_plugin_config ("my_var", "value");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.set_plugin_config ("my_var", "value")}@* -@* - -@end itemize - - -@c **************************** Autores / Soporte ***************************** - -@node Autores / Soporte, , Plugins, Top -@chapter Autores / Soporte - -@ifhtml -@menu -* Autores:: -* Obtener soporte/ayuda:: -* Copyright:: -@end menu -@end ifhtml -@ifnothtml -@menu -* Autores:: -* Obtener soporte/ayuda:: -@end menu -@end ifnothtml - -@node Autores, Obtener soporte/ayuda, Autores / Soporte, Autores / Soporte -@section Autores - -WeeChat est@'a desarollado por:@* - -@itemize @bullet -@item -FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> - -@end itemize - -@ifhtml -@node Obtener soporte/ayuda, Copyright, Autores, Autores / Soporte -@end ifhtml -@ifnothtml -@node Obtener soporte/ayuda, , Autores, Autores / Soporte -@end ifnothtml -@section Obtener soporte/ayuda - -Antes de pedir ayuda al soporte, por favor lee la documentaci@'on y las FAQ de WeeChat.@* -(La documentaci@'on es el documento que est@'as leyendo, si no has leido todo hasta aqu@'i, -puedes hacerlo ahora ...)@* - -@itemize @bullet -@item -Soporte por IRC:@* -- servidor: @b{irc.freenode.net}@* -- canal: @b{#weechat}@*@* -@item -Foro WeeChat: @uref{http://forums.flashtux.org}@*@* -@item -Soporte mediante listas de difusi@'on:@* -- para apuntarse: @*@uref{http://mail.nongnu.org/mailman/listinfo/weechat-support}.@* -- para enviar un correo a la lista:@*@email{weechat-support@@nongnu.org}.@* - -Los archivos de la lista est@'an aqu@'i:@* -@uref{http://mail.nongnu.org/archive/html/weechat-support}@*@* -@item -Ver la p@'agina de soporte para WeeChat para m@'as detalles:@* -@uref{http://weechat.flashtux.org/support.php} - -@end itemize - -@ifhtml -@node Copyright, , Obtener soporte/ayuda, Autores / Soporte -@section Copyright - -Este manual documenta el cliente IRC WeeChat y hace parte del mismo proyecto WeeChat.@* - -Copyright @copyright{} 2005 FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* -Traducido en espa@~nol por Iznogoud <@email{iznogoud@@dlfp.org, iznogoud AT dlfp.org}>@* -@* -Este documento puede ser utilizado seg@'un los t@'erminos de la licencia GNU General Public License -versi@'on 2 o posterior. -@end ifhtml - -@bye diff --git a/weechat/doc/weechat_doc_fr.texi b/weechat/doc/weechat_doc_fr.texi deleted file mode 100644 index d3bb1e5f1..000000000 --- a/weechat/doc/weechat_doc_fr.texi +++ /dev/null @@ -1,2955 +0,0 @@ -\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) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@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 -@documentencoding ISO-8859-1 - -@titlepage - -@title WeeChat - Guide utilisateur -@subtitle Client IRC rapide, l@'eger et extensible -@subtitle Documentation pour WeeChat v0.1.7-cvs - 16 decembre 2005 - -@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{} 2005 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 (avec SSL, IPv6, proxy) -@item -plusieurs interfaces : Curses, wxWidgets, 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, MacOS X, 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{apt-get install weechat-curses} -@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 : @kbd{emerge weechat} -@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:: -* Fichier de configuration:: -* Raccourcis clavier:: -* Commandes WeeChat:: -* Tube FIFO:: -@end menu - -@node Lancer WeeChat, Fichier de configuration, Utilisation, Utilisation -@section Lancer WeeChat - -@subsection Param@`etres de ligne de commande - -@table @code -@item -a, --no-connect -Supprimer la connexion automatique aux serveurs lors du d@'emarrage@* -@item -c, --config -Afficher l'aide sur le fichier de config (liste des options)@* -@item -f, --key-functions -Afficher la liste des fonctions internes WeeChat pour les touches@* -@item -h, --help -Afficher l'aide@* -@item -i, --irc-commands -Afficher la liste des commandes IRC@* -@item -k, --keys -Afficher les touches par d@'efaut de WeeChat@* -@item -l, --license -Afficher la licence de WeeChat@* -@item -p, --no-plugin -Ne charger aucune extension lors du d@'emarrage@* -@item -v, --version -Afficher la version de WeeChat@* -@item -w, --weechat-commands -Afficher la liste des commandes WeeChat@* -@end table - -@subsection Lancer WeeChat - -Tapez simplement cette commande pour lancer WeeChat :@* -@kbd{weechat-curses} (pour l'interface Curses)@* -ou @kbd{weechat-wxwidgets} (pour l'interface wxWidgets)@* -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 Fichier de configuration, Raccourcis clavier, Lancer WeeChat, Utilisation -@section Fichier de configuration - -Liste des options du fichier de configuration :@* - -@table @kbd -@item look_set_title -D@'efinit le titre de la fen@^etre (terminal pour l'interface Curses) avec le nom et la version@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_startup_logo -Afficher le logo WeeChat au d@'emarrage@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_startup_version -Afficher la version de WeeChat au d@'emarrage@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_weechat_slogan -Slogan WeeChat (si vide, le slogan ne sera pas utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'the geekest IRC client!'@* -@item look_charset_decode_iso -Jeu de caract@`eres ISO pour d@'ecoder les messages du serveur (utilis@'e seulement si la locale est UTF-8) (si non renseign@'e, les messages ne sont pas concertis si la locale est UTF-8)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'ISO-8859-1'@* -@item look_charset_decode_utf -Jeu de caract@`eres UTF pour d@'ecoder les messages du serveur (utilis@'e seulement si la locale n'est pas UTF-8) (si non renseign@'e, les messages ne sont pas convertis si la locale n'est pas UTF-8)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'UTF-8'@* -@item look_charset_encode -Jeu de caract@`eres pour encoder les messages envoy@'es au serveur, exemples: UFT-8, ISO-8859-1 (si non renseign@'e, les messages ne sont pas convertis)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item look_charset_internal -Force le jeu de caract@`eres interne @`a WeeChat (doit @^etre vide dans la plupart des cas, ce qui signifie que le jeu de caract@`eres d@'etect@'e est utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item look_one_server_buffer -Utiliser le m@^eme tampon pour tous les serveurs@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item look_buffer_timestamp -Format de date/heure pour les tampons@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '[%H:%M:%S]'@* -@item look_color_nicks_number -Nombre de couleurs @`a utiliser pour les couleurs des pseudos@* -Type: entier (valeurs: entre 1 et 10), valeur par d@'efaut: 10@* -@item look_color_actions -Afficher les actions avec diff@'erentes couleurs@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_nicklist -Afficher la fen@^etre des utilisateurs (pour les fen@^etres de canaux)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_nicklist_position -Position de la fen@^etre d'utilisateurs (haut (top), gauche (left), droite (right, par d@'efaut), bas (bottom))@* -Type: cha@^ine (valeurs: 'left', 'right', 'top', 'bottom'), valeur par d@'efaut: 'right'@* -@item look_nicklist_min_size -Taille minimum pour la fen@^etre d'utilisateurs (largeur ou hauteur, selon look_nicklist_position (0 = pas de taille minimum))@* -Type: entier (valeurs: entre 0 et 100), valeur par d@'efaut: 0@* -@item look_nicklist_max_size -Taille maximum pour la fen@^etre d'utilisateurs (largeur ou hauteur, selon look_nicklist_position (0 = pas de taille maximum; si min == max et > 0, alors la taille est fixe))@* -Type: entier (valeurs: entre 0 et 100), valeur par d@'efaut: 0@* -@item look_no_nickname -Texte @`a afficher en lieu et place du nom d'utilisateur lorsque la connexion n'est pas active@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '-cmd-'@* -@item look_nickmode -Afficher le mode de l'utilisateur ((half)op/voice) devant chaque utilisateur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_nickmode_empty -Afficher un espace si le mode utilisateur n'est pas (half)op/voice@* -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 pseudos@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ':'@* -@item look_nick_completion_ignore -Caract@`eres @`a ignorer pour la compl@'etion des pseudos@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '[]-^'@* -@item look_infobar -Active la barre d'infos@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_infobar_timestamp -Format de date/heure dans la barre d'info@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%B, %A %d %Y'@* -@item look_infobar_seconds -Afficher les secondes pour l'heure dans la barre d'infos@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_infobar_delay_highlight -D@'elai (en secondes) pour la notification des messages dans la barre d'infos (0 = d@'esactiver les notifications dans la barre d'infos)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 7@* -@item look_hotlist_names_count -Nombre maximum de noms dans la liste d'activit@'e (0 = pas de nom affich@'e, seulement les num@'eros de tampons)@* -Type: entier (valeurs: entre 0 et 32), valeur par d@'efaut: 3@* -@item look_hotlist_names_level -Niveau pour l'affichage des noms dans la liste d'activit@'e (combinaison de: 1=join/part, 2=message, 4=priv@'e, 8=highlight, par exemple: 12=priv@'e+highlight)@* -Type: entier (valeurs: entre 1 et 15), valeur par d@'efaut: 12@* -@item look_hotlist_names_length -Nombre maximum des noms dans la liste d'activit@'e (0 = pas de limite)@* -Type: entier (valeurs: entre 0 et 32), valeur par d@'efaut: 0@* -@item look_day_change -Affiche un message quand le jour change@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item look_day_change_timestamp -Format de date pour la date affich@'ee quand le jour a chang@'e@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%a, %d %b %Y'@* -@item look_read_marker -Utiliser un marqueur sur les serveurs/canaux pour montrer la premi@`ere ligne non lue@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ' '@* -@item col_real_white -Si activ@'e, utilise la vraie couleur blanche, d@'esactiv@'e par d@'efaut pour les terminaux avec un fond blanc (si vous n'utilisez jamais de fond blanc, vous devriez activer cette option pour voir du vrai blanc au lieu de la couleur d'avant plant par d@'efaut du terminal)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item col_title -Couleur pour la barre de titre@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_title_bg -Couleur de fond pour la barre de titre@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_chat -Couleur pour le texte de discussion@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_chat_time -Couleur pour l'heure dans la fen@^etre de discussion@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_chat_time_sep -Couleur pour la s@'eparation de l'heure (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'brown'@* -@item col_chat_prefix1 -Couleur pour le 1er et le 3@`eme caract@`ere du pr@'efixe@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_chat_prefix2 -Couleur pour le caract@`ere du milieu du pr@'efixe@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_chat_server -Couleur pour le nom du serveur@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'brown'@* -@item col_chat_join -Couleur pour la fl@`eche du join (pr@'efixe)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_chat_part -Couleur pour la fl@`eche du part/quit (pr@'efixe)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightred'@* -@item col_chat_nick -Couleur pour les noms d'utilisateurs dans les actions (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_chat_host -Couleur pour les noms de machines (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_chat_channel -Couleur pour les canaux dans les actions (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_chat_dark -Couleur pour les s@'eparateurs sombres (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'green'@* -@item col_chat_highlight -Couleur pour le pseudo surlign@'e (fen@^etre de discussion)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* -@item col_chat_bg -Couleur de fond pour la fen@^etre de discussion@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_chat_read_marker -Couleur pour le marqueur de donn@'ees non lues@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* -@item col_chat_read_marker_bg -Couleur de fond pour le marqueur de donn@'ees non lues@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'magenta'@* -@item col_status -Couleur pour la barre de statut@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@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_channel -Couleur pour le canal courant dans la barre de statut@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@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: 'yellow'@* -@item col_status_private -Couleur pour une fen@^etre avec un message priv@'e (barre de statut)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@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: 'lightred'@* -@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: 'default'@* -@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'@* -@item col_status_bg -Couleur de fond pour la fen@^etre de statut@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_infobar -Couleur pour la barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'black'@* -@item col_infobar_delimiters -Couleur pour les d@'elimiteurs de la barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_infobar_highlight -Couleur pour la notification dans la barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_infobar_bg -Couleur de fond pour la fen@^etre de barre d'infos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_input -Couleur pour le texte saisi@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_input_channel -Couleur pour le texte saisi (nom du canal)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_input_nick -Couleur pour le texte saisi (pseudo)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_input_delimiters -Couleur pour le texte saisi (d@'elimiteurs)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_input_bg -Couleur de fond pour la fen@^etre de saisie@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_nick -Couleur pour les pseudos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_nick_away -Couleur pour les pseudos absents@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_nick_chanowner -Couleur pour le symbole du propri@'etaire du canal (sp@'ecifique @`a unrealircd)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_chanadmin -Couleur pour le symbole administrateur du canal (sp@'ecifique @`a unrealircd)@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_op -Couleur pour le symbole op@'erateur@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_halfop -Couleur pour le symbole demi-op@'erateur@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@item col_nick_voice -Couleur pour le symbole voix@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'yellow'@* -@item col_nick_more -Couleur pour les '+' lors du scroll sur les pseudos@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@item col_nick_sep -Couleur pour le s@'eparateur de pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_nick_self -Couleur pour le pseudo local@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'white'@* -@item col_nick_color1 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'cyan'@* -@item col_nick_color2 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'magenta'@* -@item col_nick_color3 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'green'@* -@item col_nick_color4 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'brown'@* -@item col_nick_color5 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightblue'@* -@item col_nick_color6 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@item col_nick_color7 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightcyan'@* -@item col_nick_color8 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightmagenta'@* -@item col_nick_color9 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'lightgreen'@* -@item col_nick_color10 -Couleur pour le pseudo@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'blue'@* -@item col_nick_private -Couleur pour l'autre pseudo dans la fen@^etre priv@'ee@* -Type: couleur (couleur Curses ou Gtk), valeur par d@'efaut: 'default'@* -@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: 'lightcyan'@* -@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 history_display_default -Nombre maximum de commandes @`a afficher par d@'efaut dans le listing d'historique (0 = sans limite)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 5@* -@item log_auto_server -Enregistrer automatiquement les messages du serveur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item log_auto_channel -Enregistrer automatiquement les conversations des canaux@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item log_auto_private -Enregistrer automatiquement les conversations priv@'ees@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item log_plugin_msg -Enregistrer les messages des plugins (scripts)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@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_timestamp -Format de date/heure pour les conversations sauvegard@'ees (voir man strftime pour le format de date/heure)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Masquer le mot de passe affich@'e par nickserv@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item irc_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 irc_default_msg_away -Message par d@'efaut pour l'absence@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'away'@* -@item irc_default_msg_part -Message par d@'efaut pour le part (quitte un canal)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'WeeChat %v'@* -@item irc_default_msg_quit -Message de fin par d@'efaut ('%v' sera remplac@'e par la version de WeeChat dans la cha@^ine)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: 'WeeChat %v'@* -@item irc_notice_as_pv -Afficher les notices comme des messages priv@'es@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item irc_away_check -Intervalle entre deux v@'erifications des absences (en minutes, 0 = ne jemais v@'erifier)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 0@* -@item irc_lag_check -Intervalle entre deux mesures de lag (en secondes)@* -Type: entier (valeurs: entre 30 et 2147483647), valeur par d@'efaut: 60@* -@item irc_lag_min_show -Lag minimum @`a afficher (en secondes)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 1@* -@item irc_lag_disconnect -D@'econnexion apr@`es un lag important (en minutes, 0 = ne jamais se d@'econnecter)@* -Type: entier (valeurs: entre 0 et 2147483647), valeur par d@'efaut: 5@* -@item irc_fifo_pipe -Cr@'eer un tube FIFO pour le contr@^ole @`a distance@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item irc_highlight -Liste des mots pour la notification (s@'epar@'es par des virgules, le comparaison ne tient pas compte de la casse, les mots peuvent commencer ou se terminer par "*" pour une comparaison partielle)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item irc_colors_receive -Si d@'esactiv@'e, les codes couleurs des messages entrants sont ignor@'es@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item irc_colors_send -Autorise l'utilisateur @`a envoyer des couleurs avec des codes sp@'eciaux (%B=gras, %Cxx,yy=couleur, %U=soulign@'e, %R=invers@'e)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_accept_files -Accepte automatiquement les fichiers dcc entrants@* -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: 'off'@* -@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: 65536)@* -Type: entier (valeurs: entre 1024 et 102400), valeur par d@'efaut: 65536@* -@item dcc_port_range -Restreint le dcc sortant @`a utiliser des ports dans la plage donn@'ee (pratique pour le NAT) (syntaxe: un port simple, par exemple 5000, une plage de ports, par exemple 5000-5015, si non renseign@'e tout port peut @^etre utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item dcc_own_ip -Adresse IP ou DNS utilis@'ee pour le dcc sortant (si non renseign@'e, l'interface IP locale est utilis@'ee)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@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: '~'@* -@item dcc_upload_path -Chemin pour lire les fichiers lorsqu'ils sont envoy@'es par dcc (quand aucun chemin n'est sp@'ecifi@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~'@* -@item dcc_convert_spaces -Convertir les espaces en underscores lors d'envoi de fichiers@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_rename -Renommer les fichiers re@,{c}us s'ils existent d@'ej@`a (ajoute '.1', '.2', ...)@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item dcc_auto_resume -Continuer automatiquement les transferts dcc si la connexion avec la machine distante a @'et@'e perdue@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item proxy_use -Utiliser un proxy pour se connecter au serveur irc@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item proxy_type -Type de proxy (http (d@'efaut), socks4, socks5)@* -Type: cha@^ine (valeurs: 'http', 'socks4', 'socks5'), valeur par d@'efaut: 'http'@* -@item proxy_ipv6 -Se connecter au proxy en ipv6@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item proxy_address -Adresse du serveur proxy (IP ou nom)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item proxy_port -Port pour se connecter au serveur proxy@* -Type: entier (valeurs: entre 0 et 65535), valeur par d@'efaut: 3128@* -@item proxy_username -Nom d'utilisateur pour le serveur proxy@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item proxy_password -Mot de passe pour le serveur proxy@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item plugins_path -Chemin de recherche des extensions@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '~/.weechat/plugins'@* -@item plugins_autoload -Liste des extensions @`a charger automatiquement au d@'emarrage, "*" signifie toutes (s@'epar@'ees par des virgules, les noms peuvent @^etre partiels, par exemple "perl" est ok pour "libperl.so")@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '*'@* -@item plugins_extension -Extension standard des extensions dans le nom de fichier, pour le chargement automatique (si vide, alors tous les fichiers sont charg@'es si autoload vaut "*")@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: '.so'@* -@item server_name -Nom associ@'e au serveur IRC (pour affichage seulement)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_autoconnect -Connexion automatique au serveur quand WeeChat d@'emarre@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item server_autoreconnect -Reconnexion automatique au serveur apr@`es une d@'econnexion@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item server_autoreconnect_delay -D@'elai (en secondes) avant de tenter une reconnexion au serveur@* -Type: entier (valeurs: entre 0 et 65535), valeur par d@'efaut: 30@* -@item server_address -Adresse IP ou nom du serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_port -Port pour se connecter au serveur@* -Type: entier (valeurs: entre 0 et 65535), valeur par d@'efaut: 6667@* -@item server_ipv6 -Utiliser le protocole IPv6 pour la communication avec le serveur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item server_ssl -Utiliser SSL pour la communication avec le serveur@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'off'@* -@item server_password -Mot de passe pour le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_nick1 -Pseudo @`a utiliser sur le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_nick2 -Pseudo alternatif pour le serveur IRC (si le pseudo est d@'ej@`a utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_nick3 -2nd pseudo alternatif pour le serveur IRC (si le pseudo alternatif est d@'ej@`a utilis@'e)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_username -Nom d'utilisateur pour le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_realname -Nom r@'eel pour le serveur IRC@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_command -Commande @`a ex@'ecuter en premier lorsque connect@'e au serveur@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_command_delay -D@'elai (en secondes) apr@`es ex@'ecution de la commande (exemple: donner du temps pour l'authentification)@* -Type: entier (valeurs: entre 0 et 5), valeur par d@'efaut: 0@* -@item server_autojoin -Liste des canaux (s@'epar@'es par des virgules) @`a rejoindre lorsque connect@'e au serveur (exemple: "#chan1,#chan2,#chan3 key1,key2")@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_autorejoin -Rejoindre automatiquement les canaux quand mis dehors@* -Type: bool@'een (valeurs: 'on' ou 'off'), valeur par d@'efaut: 'on'@* -@item server_notify_levels -Liste des niveaux de notifications (s@'epar@'es par des virgules) pour les canaux de ce serveur (format: #canal:1,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_charset_decode_iso -Liste des jeux de caract@`eres (s@'epar@'es par des virgules) pour le serveur et les canaux, pour d@'ecoder l'ISO (format: server:charset,#canal:charset,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_charset_decode_utf -Liste des jeux de caract@`eres (s@'epar@'es par des virgules) pour le serveur et les canaux, pour d@'ecoder l'UTF (format: server:charset,#canal:charset,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@item server_charset_encode -Liste des jeux de caract@`eres (s@'epar@'es par des virgules) pour le serveur et les canaux, pour encoder les messages (format: server:charset,#canal:charset,..)@* -Type: cha@^ine (toute cha@^ine), valeur par d@'efaut: ''@* -@end table - -Les couleurs pour l'interface Curses sont :@* -@itemize @minus -@item -@kbd{default}: couleur par d@'efaut (transparent pour le fond) -@item -@kbd{black}: noir -@item -@kbd{red}: rouge fonc@'e -@item -@kbd{lightred}: rouge clair -@item -@kbd{green}: vert fonc@'e -@item -@kbd{lightgreen}: vert clair -@item -@kbd{brown}: marron -@item -@kbd{yellow}: jaune -@item -@kbd{blue}: bleu fonc@'e -@item -@kbd{lightblue}: bleu clair -@item -@kbd{magenta}: violet fonc@'e -@item -@kbd{lightmagenta}: violet clair -@item -@kbd{cyan}: cyan fonc@'e -@item -@kbd{lightcyan}: cyan clair -@item -@kbd{white}: blanc -@end itemize - -@node Raccourcis clavier, Commandes WeeChat, Fichier de configuration, 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 / Ctrl + A -Aller au d@'ebut de la ligne de commande@* -@* -@item End / Ctrl + E -Aller @`a la fin de la ligne de commande@* -@* -@item Ctrl + K -Efface jusqu'@`a la fin de la ligne@* -@* -@item Ctrl + L -R@'eaffiche toute la fen@^etre@* -@* -@item Ctrl + U -Efface jusqu'au d@'ebut de la ligne@* -@* -@item Ctrl + W -Effacer le mot pr@'ec@'edent sur la ligne de commande@* -@* -@item Backspace / Delete -Effacer le mot pr@'ec@'edent / suivant 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 Ctrl + fl@`eche haut / Ctrl + fl@`eche bas -Rappeler les derni@`eres commandes/messages dans l'historique global@* -@* -@item PageUp / PageDown -Afficher l'historique du tampon@* -@* -@item F5 / F6 -Aller au tampon pr@'ec@'edent / suivant@* -@* -@item F7 / F8 -Aller @`a la fen@^etre pr@'ec@'edente / suivante@* -@* -@item F10 -Effacer le dernier message de la barre d'infos@* -@* -@item F11 / F12 -Faire d@'efiler la liste des pseudos@* -@* -@item Alt + fl@`eche gauche / Alt + fl@`eche droite -Identique @`a F5 / F6@* -@* -@item Alt + A -Sauter au tampon avec activit@'e (avec priorit@'e: highlight, message, autre)@* -@* -@item Alt + B -Aller au mot pr@'ec@'edent@* -@* -@item Alt + D -Effacer le mot suivant@* -@* -@item Alt + F -Aller au mot suivant@* -@* -@item Alt + H -Vide la hotlist (notification d'activit@'e sur les autres tampons)@* -@* -@item Alt + J puis Alt + D -Afficher les DCC en cours@* -@* -@item Alt + J puis Alt + L -Sauter au dernier tampon@* -@* -@item Alt + J puis Alt + S -Sauter au tampon du serveur@* -@* -@item Alt + J puis Alt + X -Sauter au premier canal du serveur suivant (ou tampon du serveur si aucun canal ouvert)@* -@* -@item Alt + chiffre (1-9) -Sauter au tampon avec ce num@'ero@* -@* -@item Alt + J puis nombre (01-99) -Sauter au tampon avec ce num@'ero@* -@* -@item Alt + K -Capturer une touche -@* -@item Alt + N -Se positionner sur le highlight suivant@* -@* -@item Alt + P -Se positionner sur le highlight pr@'ec@'edent@* -@* -@item Alt + R -Effacer la ligne enti@`ere@* -@* -@item Alt + S -Changer de serveur sur le tampon des serveurs@* -(si l'option ``look_one_server_buffer'' est activ@'ee)@* -@* -@item Alt + U -Se positionner sur la premi@`ere ligne non lue du tampon@* -@* -@item Alt + W puis Alt + fl@`eche -Sauter @`a une fen@^etre avec une direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Faire d@'efiler la liste des pseudos@* -@* -@end table - -@node Commandes WeeChat, Tube FIFO, Raccourcis clavier, Utilisation -@section Commandes WeeChat - -Commandes internes WeeChat :@* - -@table @kbd -@item alias [nom_alias [commande [param@`etres]] -@* -cr@'eer un alias pour une commande@* -@* -nom_alias: nom de l'alias@* -commande: nom de la commande (commande WeeChat ou IRC, sans le premier '/')@* -param@`etres: param@`etres pour la commande@* -@* -@item buffer [action | nombre | [[serveur] [canal]]] -@* -gestion des tampons@* -@* -action: action @`a effectuer:@* - move: d@'eplacer le tampon dans la liste (peut @^etre relatif, par exemple -1)@* - close: fermer le tampon (pour un canal: @'equivalent @`a /part sans message de fin)@* - list: liste les tampons ouverts (pas de param@`etre affiche cette liste)@* - notify: fixer le niveau de notification (0=jamais, 1=highlight, 2=1+msg, 3=2+join/part)@* -serveur,canal: sauter au tampon par serveur et/ou nom de canal@* -nombre: sauter au tampon qui a ce num@'ero@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -changer le jeu de caract@`eres pour le serveur ou le canal@* -@* -decode_iso: jeu de caract@`eres utilis@'e pour d@'ecoder l'ISO@* -decode_utf: jeu de caract@`eres utilis@'e pour d@'ecoder l'UTF@* - encode: jeu de caract@`eres utilis@'e pour encoder les messages@* - charset: jeu de caract@`eres @`a utiliser (par exemple: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -effacer la/les fen@^etre(s)@* -@* --all: effacer toutes les fen@^etres@* -@* -@item connect [nom_serveur] -@* -se connecter @`a un serveur@* -@* -nom_serveur: nom du serveur pour se connecter@* -@* -@item disconnect [nom_serveur] -@* -se d@'econnecter d'un serveur@* -@* -nom_serveur: nom du serveur pour se d@'econnecter@* -@* -@item debug dump | windows -@* -affiche des messages de debuggage@* -@* -dump: affiche les variables m@'emoire WeeChat dans le fichier log (les m@^emes messages sont affich@'es lorsque WeeChat plante)@* -windows: affiche l'arbre des fen@^etres@* -@* -@item help [commande] -@* -afficher l'aide sur les commandes@* -@* -commande: nom d'une commande WeeChat ou IRC@* -@* -@item history [clear | valeur] -@* -affiche l'historique des commandes du tampon@* -@* -clear: effacer l'historique@* -valeur: nombre d'entr@'ees dans l'historique @`a afficher@* -@* -@item ignore [masque [[type | commande] [canal [serveur]]]] -@* -ignorer des messages IRC et/ou des masques@* -@* - masque: pseudo ou masque @`a ignorer@* - type: type de message @`a ignorer (action, ctcp, dcc, pv)@* -commande: commande IRC@* - canal: nom du canal pour le ignore@* - serveur: nom du serveur pour le ignore@* -@* -Pour chaque param@`etre, '*' signifie tou(te)s.@* -Sans param@`etre, la commande /ignore liste les ignore d@'efinis.@* -@* -@item key [touche fonction/commande] [unbind touche] [functions] [reset -yes] -@* -associer/lib@'erer des touches@* -@* -touche: associer cette touche @`a une fonction interne ou une commande (commen@,{c}ant par "/")@* -unbind: supprimer l'association @`a une touche (si "all", toutes les associations de touches par d@'efaut sont restaur@'ees)@* -functions: lister la liste des fonctions internes pour les associations de touches@* -reset: restaure les touches aux valeurs par d@'efaut et supprime TOUTES les touches personnelles (utiliser avec pr@'ecaution !)@* -@* -@item plugin [load fichier] | [autoload] | [reload] | [unload] -@* -liste/charge/d@'echarge des extensions@* -@* -fichier: extension WeeChat (fichier) @`a charger@* -@* -Sans param@`etre, la commande /plugin liste toutes les extensions charg@'ees.@* -@* -@item server [nom_serveur] | [nom_serveur nom/IP port [-auto | -noauto] [-ipv6] [-ssl] [-pwd mot_de_passe] [-nicks pseudo1 pseudo2 pseudo3] [-username nom_utilisateur] [-realname nom_r@'eel] [-command commande] [-autojoin canal[,canal]] ] | [del nom_serveur] -@* -liste, ajoute ou retire des serveurs@* -@* -nom_serveur: nom du serveur, pour usage interne et affichage@* -nom/IP: nom ou adresse IP du serveur@* -port: port pour le serveur (nombre entier)@* -ipv6: utiliser le protocole IPv6@* -ssl: utiliser le protocole SSL@* -mot_de_passe: mot de passe pour le serveur@* -pseudo1: premier pseudo pour le serveur@* -pseudo2: pseudo alternatif pour le serveur@* -pseudo3: second pseudo alternatif pour le serveur@* -nom_utilisateur: nom d'utilisateur@* -nom_r@'eel: nom r@'eel de l'utilisateur@* -@* -@item save [fichier] -@* -sauvegarder la configuration sur disque@* -@* -fichier: fichier pour sauvegarder la configuration@* -@* -@item set [option [ = valeur]] -@* -modifier des param@`etres de configuration@* -@* -option: nom de l'option (si le nom est complet et qu'aucune valeur n'est donn@'ee, alors l'aide sur l'option est affich@'ee)@* -valeur: valeur pour l'option@* -@* -@item unalias nom_alias -@* -supprimer un alias@* -@* -nom_alias: nom de l'alias @`a supprimer@* -@* -@item unignore [nombre | [masque [[type | commande] [canal [serveur]]]]] -@* -supprimer le ignore des messages IRC et/ou des masques@* -@* - nombre: num@'ero de ignore @`a supprimer (le nombre est affich@'e sur la liste des ignore)@* - masque: pseudo ou masque @`a ignorer@* - type: type de message @`a ignorer (action, ctcp, dcc, pv)@* -commande: commande IRC@* - canal: nom du canal pour le ignore@* - serveur: nom du serveur pour le ignore@* -@* -Pour chaque param@`etre, '*' signifie tou(te)s.@* -Sans param@`etre, /ignore liste les ignore d@'efinis.@* -@* -@item upgrade -@* -mettre @`a jour WeeChat sans se d@'econnecter des serveurs@* -@* -@item uptime [-o] -@* -montrer l'uptime de WeeChat@* -@* --o: envoyer l'uptime sur le canal courant en tant que message IRC@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [ptc] | resize pct | merge [all]] -@* -gestion des fen@^etres@* -@* -list: liste les fen@^etres ouvertes (pas de param@`etre affiche cette liste)@* --1: saute @`a la fen@^etre pr@'ec@'edente@* -+1: saute @`a la fen@^etre suivante@* -b#: saute @`a la fen@^etre affichant le tampon n°#@* -up: saute @`a la fen@^etre au dessus@* -down: saute @`a la fen@^etre au dessous@* -left: saute @`a la fen@^etre @`a gauche@* -right: saute @`a la fen@^etre @`a droite@* -splith: @'eclate la fen@^etre en deux horizontalement@* -splitv: @'eclate la fen@^etre en deux verticalement@* -resize: redimensionne une fen@^etre, la nouvelle taille est <pct>%% de la fen@^etre parent@* -merge: fusionne la fen@^etre avec une autre@* -@* -Pour splith et splitv, pct est un pourcentage qui repr@'esente la taille de la nouvelle fen@^etre, calcul@'ee par rapport @`a la taille de la fen@^etre courante. Par exemple 25 signifie cr@'eer une fen@^etre qui a pour taille: taille_courante / 4@* -@* -@end table - -Commandes IRC :@* - -@table @kbd -@item admin [cible] -@* -trouver les informations sur l'administrateur du serveur@* -@* -cible: serveur@* -@* -@item ame message -@* -envoyer une action CTCP @`a tous les canaux de tous les serveurs connect@'es@* -@* -message: message @`a envoyer@* -@* -@item amsg texte -@* -envoyer un message @`a tous les canaux de tous les serveurs connect@'es@* -@* -texte: texte @`a envoyer@* -@* -@item away [-all] [message] -@* -basculer le statut absent@* -@* --all: basculer le statut absent sur tous les serveurs connect@'es@* -message: message pour l'absence (si pas de message donn@'e, le statut d'absence est supprim@'e)@* -@* -@item ban [canal] [pseudo [pseudo ...]] -@* -bannit des pseudos ou masques@* -@* -canal: nom du canal pour le bannissement@* -pseudo: pseudo ou masque pour le bannissement@* -@* -@item ctcp pseudo type [arguments] -@* -envoyer un message CTCP (Client-To-Client Protocol)@* -@* -pseudo: utilisateur @`a qui envoyer le CTCP@* -type: type de CTCP (exemples: "version", "ping", etc...)@* -arguments: arguments pour le CTCP@* -@* -@item dcc action [pseudo [fichier]] -@* -d@'emarre le DCC (fichier ou discussion) ou ferme une discussion@* -@* -action: 'send' (envoi de fichier) ou 'chat' (discussion) ou 'close' (fermeture discussion)@* -pseudo: pseudo pour envoyer le fichier ou discuter@* -fichier: nom du fichier (sur la machine locale)@* -@* -@item dehalfop [pseudo [pseudo]] -@* -retire le statut de demi-op@'erateur du canal @`a/aux nick(s)@* -@* -@item deop [pseudo [pseudo]] -@* -retire le statut d'op@'erateur du canal @`a/aux nick(s)@* -@* -@item devoice [pseudo [pseudo]] -@* -retire la voix du/des pseudo(s)@* -@* -@item die -@* -arr@^eter le serveur@* -@* -@item halfop [pseudo [pseudo]] -@* -donner le statut de demi-op@'erateur @`a un/des utilisateur(s)@* -@* -@item info [cible] -@* -voir les informations d@'ecrivant le serveur@* -@* -cible: nom du serveur@* -@* -@item invite pseudo canal -@* -inviter un utilisateur sur un canal@* -@* -pseudo: utilisateur @`a inviter@* -channel: canal pour l'invitation@* -@* -@item ison pseudo [pseudo ...] -@* -v@'erifier si un utilisateur est actuellement sur IRC@* -@* -pseudo: pseudo@* -@* -@item join canal[,canal] [cl@'e[,cl@'e]] -@* -joindre un canal@* -@* -canal: nom du canal @`a rejoindre@* -cl@'e: cl@'e pour rejoindre le canal@* -@* -@item kick [canal] pseudo [commentaire] -@* -retirer par la force un utilisateur d'un canal@* -@* -canal: canal o@`u l'utilisateur se trouve@* -pseudo: utilisateur @`a @'eliminer@* -commentaire: commentaire pour l'@'elimination@* -@* -@item kickban [canal] pseudo [commentaire] -@* -retirer par la force un utilisateur d'un canal et le bannir@* -@* -canal: canal o@`u l'utilisateur se trouve@* -pseudo: utilisateur @`a @'eliminer et bannir@* -commentaire: commentaire pour l'@'elimination@* -@* -@item kill pseudo commentaire -@* -fermer la connexion client-serveur@* -@* -pseudo: utilisateur@* -commentaire: commentaire pour la mort@* -@* -@item links [[serveur] masque_serveur] -@* -lister tous les noms de serveurs connus du serveur qui r@'epondent @`a la requ@^ete@* -@* -serveur: ce serveur doit r@'epondre @`a la requ@^ete@* -masque_serveur: liste des serveurs correspondant au masque@* -@* -@item list [canal[,canall] [serveur]] -@* -lister les canaux et leur sujet@* -@* -canal: canal @`a lister@* -serveur: nom du serveur@* -@* -@item lusers [masque [cible]] -@* -obtenir des statistiques sur la taille du r@'eseau IRC@* -@* -masque: serveurs qui correspondent au masque seulement@* -cible: serveur pour faire suivre la requ@^ete@* -@* -@item me message -@* -envoyer une action CTCP au canal courant@* -@* -message: message @`a envoyer@* -@* -@item mode @{ canal @{[+|-]|o|p|s|i|t|n|b|v@} [limite] [utilisateur] [masque de banissement] @} | @{ nick @{[+|-]|i|w|s|o@} @} -@* -changer le mode du canal ou de l'utilisateur@* -@* -modes de canaux :@* - canal: nom du canal @`a modifier@* - o: donner/reprendre le statut privil@'egi@'e d'op@'erateur@* - p: indicateur de canal priv@'e@* - s: indicateur de canal secret@* - i: indicateur de canal avec invitation seulement@* - t: le titre est modifiable seulement par un op@'erateur du canal@* - n: aucun message au canal depuis l'ext@'erieur@* - m: canal mod@'er@'e@* - l: fixer la limite d'utilisateurs pour le canal@* - b: param@'etrer un masque de banissement pour garder des utilisateurs dehors@* - e: param@'etrer un masque d'exception@* - v: donner/reprendre la possibilit@'e de parler sur un canal mod@'er@'e@* - k: d@'efinir une cl@'e (mot de passe) pour acc@'eder au canal@* -modes utilisateur :@* - pseudo: utilisateur @`a modifier@* - i: marquer un utilisateur comme invisible@* - s: marquer un utilisateur pour recevoir les notices du serveur@* - w: l'utilisateur re@,{c}oit les wallops@* - o: drapeau op@'erateur@* -@* -@item motd [cible] -@* -obtenir le message du jour@* -@* -cible: nom du serveur@* -@* -@item msg cible[,cible] texte -@* -envoyer un message @`a un utilisateur ou canal@* -@* -cible: utilisateur ou canal (peut-@^etre un masque, '*' = canal courant)@* -texte: texte @`a envoyer@* -@* -@item names [canal[,canal]] -@* -lister les utilisateurs sur des canaux@* -@* -canal: nom du canal@* -@* -@item nick [-all] pseudo -@* -changer le pseudo courant@* -@* --all: d@'efinir le nouveau pseudo sur tous les serveurs connect@'es@* -pseudo: nouveau pseudo@* -@* -@item notice pseudo texte -@* -envoyer un message notice @`a un utilisateur@* -@* -pseudo: utilisateur cible pour la notice@* -texte: texte @`a envoyer@* -@* -@item op pseudo [pseudo] -@* -donner le statut op@'erateur @`a un/des utilisateur(s)@* -@* -@item oper utilisateur mot_de_passe -@* -obtenir le statut d'op@'erateur@* -@* -utilisateur/mot_de_passe: utilis@'e pour obtenir les privil@`eges sur le serveur IRC courant@* -@* -@item part [canal[,canall] [message_de_fin] -@* -quitter un canal@* -@* -canal: canal @`a quitter@* -message_de_fin: message de fin (affich@'e aux autres utilisateurs)@* -@* -@item ping serveur1 [serveur2] -@* -pinguer un serveur@* -@* -serveur1: serveur @`a pinguer@* -serveur2: faire suivre le ping @`a ce serveur@* -@* -@item pong d@'emon [d@'emon2] -@* -r@'epondre @`a un message ping@* -@* -d@'emon: d@'emon qui a r@'epondu au message Ping@* -d@'emon2: faire suivre le message @`a ce d@'emon@* -@* -@item query pseudo [texte] -@* -envoyer un message priv@'e @`a un utilisateur@* -@* -pseudo: utilisateur pour la conversation priv@'ee@* -texte: texte @`a envoyer@* -@* -@item quit [message_de_fin] -@* -fermer toutes les connexions et quitter@* -@* -message_de_fin: message de fin (affich@'e aux autres utilisateurs)@* -@* -@item quote donn@'ees -@* -envoyer des donn@'ees brutes au serveur sans analyse@* -@* -donn@'ees: donn@'ees brutes @`a envoyer@* -@* -@item rehash -@* -demander au serveur de recharger son fichier de configuration@* -@* -@item restart -@* -demander au serveur de red@'emarrer@* -@* -@item service pseudo r@'eserv@'e distribution type r@'eserv@'e info -@* -enregister un nouveau service@* -@* -distribution: visibilit@'e du service@* -type: r@'eserv@'e pour une utilisation future@* -@* -@item servlist [masque [type]] -@* -lister les services actuellement connect@'es au r@'eseau@* -@* -masque: lister seulement les services qui correspondent @`a ce masque@* -type: lister seulement les services de ce type@* -@* -@item squery service texte -@* -envoyer un message @`a un service@* -@* -service: nom du service@* -texte: texte @`a envoyer@* -@* -@item squit serveur commentaire -@* -d@'econnecter les liens vers un serveur@* -@* -serveur: nom du serveur@* -commentaire: commentaire pour quitter@* -@* -@item stats [requ@^ete [serveur]] -@* -demander des statistiques sur le serveur@* -@* -requ@^ete: c/h/i/k/l/m/o/y/u (voir la RFC1459)@* -serveur: nom du serveur@* -@* -@item summon utilisateur [cible [canal]] -@* -envoyer aux utilisateurs d'un serveur IRC un message leur demandant de rejoindre IRC@* -@* -utilisateur: nom d'utilisateur@* -cible: nom du serveur@* -canal: nom du canal@* -@* -@item time [cible] -@* -demander l'heure locale de serveur@* -@* -cible: demander l'heure de ce serveur@* -@* -@item topic [canal] [titre] -@* -recevoir/d@'efinir le titre du canal@* -@* -canal: nom du canal@* -titre: nouveau titre pour le canal (si le titre est "-delete" alors le titre est supprim@'e)@* -@* -@item trace [cible] -@* -trouver le chemin jusqu'@`a un serveur sp@'ecifique@* -@* -cible: serveur@* -@* -@item unban [canal] pseudo [pseudo ...] -@* -supprime le bannissement sur des pseudos ou masques@* -@* -canal: nom du canal pour supprimer le bannissement@* -pseudo: pseudo ou masque pour supprimer le bannissement@* -@* -@item userhost pseudo [pseudo ...] -@* -retourne une liste d'informations sur des utilisateurs@* -@* -pseudo: pseudo@* -@* -@item users [cible] -@* -liste des utilisateurs connect@'es au serveur@* -@* -cible: serveur@* -@* -@item version [serveur | pseudo] -@* -retourne la version de l'utilisateur ou du serveur (courant ou sp@'ecifi@'e)@* -@* -serveur: nom du serveur@* -pseudo: utilisateur@* -@* -@item voice [pseudo [pseudo]] -@* -donne la voix @`a/aux utilisateur(s)@* -@* -@item wallops texte -@* -envoyer un message @`a tous les utilisateurs connect@'es qui ont activ@'e le mode utilisateur 'w' pour eux-m@^emes@* -@* -texte @`a envoyer@* -@* -@item who [masque ["o"]] -@* -g@'en@`ere une requ@^ete qui retourne une liste d'information@* -@* -masque: information qui correspond @`a ce masque uniquement@* -o: seul les op@'erateurs sont retourn@'es correspondant au masque fourni@* -@* -@item whois [serveur] pseudo[,pseudo] -@* -demande les informations sur le(s) utilisateur(s)@* -@* -serveur: nom du serveur@* -pseudo: utilisateur (peut @^etre un masque)@* -@* -@item whowas pseudo [,pseudo [,pseudo ...]] [nombre [cible]] -@* -demander de l'information sur un nick qui n'existe plus@* -@* -pseudo: pseudo @`a chercher@* -nombre: nombre de r@'eponses @`a retourner (recherche compl@`ete si nombre n@'egatif)@* -cible: la r@'eponse doit correspondre @`a ce masque@* -@* -@end table - -Fonctions internes pour les touches :@* - -@table @kbd -@item return -terminer la ligne@* -@item tab -compl@'eter le mot@* -@item backspace -effacer le caract@`ere pr@'ec@'edent@* -@item delete -effacer le caract@`ere suivant@* -@item delete_end_line -effacer jusqu'@`a la fin de la ligne@* -@item delete_beginning_line -effacer jusqu'au d@'ebut de la ligne@* -@item delete_line -effacer la ligne enti@`ere@* -@item delete_previous_word -effacer le mot pr@'ec@'edent@* -@item delete_next_word -effacer le mot suivant@* -@item clipboard_paste -coller le contenu du presse-papier@* -@item transpose_chars -inverser les caract@`eres@* -@item home -aller au d@'ebut de la ligne@* -@item end -aller @`a la fin de la ligne@* -@item left -se d@'eplacer d'un caract@`ere @`a gauche@* -@item previous_word -se d@'eplacer au mot pr@'ec@'edent@* -@item right -se d@'eplacer d'un caract@`ere @`a droite@* -@item next_word -se d@'eplacer au mot suivant@* -@item up -appeler la commande pr@'ec@'edente dans l'historique@* -@item up_global -appeler la commande pr@'ec@'edente dans l'historique global@* -@item down -appeler la commande suivante dans l'historique@* -@item down_global -appeler la commande suivante dans l'historique global@* -@item page_up -faire d@'efiler d'une page vers le haut@* -@item page_down -faire d@'efiler d'une page vers le bas@* -@item nick_beginning -afficher le d@'ebut de la liste des pseudos@* -@item nick_end -afficher la fin de la liste des pseudos@* -@item nick_page_up -faire d@'efiler la liste des pseudos d'une page vers le haut@* -@item nick_page_down -faire d@'efiler la liste des pseudos d'une page vers le bas@* -@item jump_smart -sauter au tampon avec de l'activit@'e@* -@item jump_dcc -sauter au tampon DCC@* -@item jump_last_buffer -sauter au dernier tampon@* -@item jump_server -sauter au tampon du serveur@* -@item jump_next_server -sauter au prochain serveur@* -@item switch_server -bascule de serveur actif sur le tampon des serveurs@* -@item scroll_previous_highlight -scroller jusqu'au highlight pr@'ec@'edent du tampon@* -@item scroll_next_highlight -scroller jusqu'au highlight suivant du tampon@* -@item scroll_unread -scroller jusqu'@`a la premi@`ere ligne non lue du tampon@* -@item hotlist_clear -effacer la liste d'activit@'e@* -@item infobar_clear -effacer la barre d'infos@* -@item refresh -rafraichir l'@'ecran@* -@item grab_key -capturer une touche@* -@end table - -@node Tube FIFO, , Commandes WeeChat, Utilisation -@section Tube FIFO - -Vous pouvez contr@^oler WeeChat @`a distance, en envoyant des commandes ou du -texte dans un tube FIFO (l'option "irc_fifo_pipe" doit @^etre activ@'ee, elle -est d@'esactiv@'ee par d@'efaut).@* -Le tube FIFO est dans le r@'epertoire ~/.weechat/ et s'appelle "weechat_fifo_xxxxx" -(o@`u xxxxx est l'ID du processus (PID) du WeeChat qui tourne).@* -Donc si plusieurs WeeChat tournent, vous avez plusieurs tubes FIFO, un pour -chaque session.@* -@* -La syntaxe pour envoyer des commandes ou du texte dans le tube FIFO est la suivante :@* -@command{serveur,canal *texte ou commande ici}@* -o@`u le serveur et le canal sont facultatifs, mais si le canal est l@`a, le -serveur doit l'@^etre aussi.@* -@* -Quelques exemples : -@table @asis -@item @bullet{} changement du pseudo sur freenode en "pseudo|absent": -@* -@command{echo "freenode */nick pseudo|absent" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} affichage de texte sur le canal #weechat : -@* -@command{echo "freenode,#weechat *bonjour tout le monde !" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} affichage de texte sur le canal courant (le tampon affich@'e par WeeChat): -@* -@command{echo "*bonjour !" >~/.weechat/weechat_fifo_12345} -@* -@b{Attention :} ceci est dangereux et vous ne devriez pas le faire sauf si vous savez ce que vous faites ! -@* -@item @bullet{} envoyer deux commandes pour d@'echarger/recharger les scripts Perl (vous devez les s@'eparer par \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -Vous pouvez @'ecrire un script qui envoie les commandes @`a tous les WeeChat qui -tournent en m@^eme temps, par exemple :@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -Si le script s'appelle "auto_weechat_command", vous pouvez le lancer ainsi :@* -@command{./auto_weechat_command "freenode,#weechat *bonjour"} - - -@c ******************************* Extensions ********************************* - -@node Extensions, Auteurs / Support, Utilisation, Top -@chapter Extensions - -@menu -* Les extensions dans WeeChat:: -* Ecrire une extension:: -* Exemple d'extension:: -* Extensions pour scripts:: -@end menu - -@node Les extensions dans WeeChat, Ecrire une extension, Extensions, Extensions -@section Les extensions dans WeeChat - -Une extension (``plugin'' en anglais) est un programme @'ecrit en C -qui peut appeler des fonctions de WeeChat d@'efinies dans une -interface.@* -Ce programme C n'a pas besoin des sources WeeChat pour @^etre -compil@'e et peut @^etre charg@'e/d@'echarg@'e dynamiquement dans -WeeChat via la commande @command{/plugin}.@* -@* -L'extension doit @^etre au format biblioth@`eque, chargeable -dynamiquement par le syst@^eme d'exploitation.@* -Sous GNU/Linux, il s'agit d'un fichier ayant pour extension ``.so'', -sous Windows ``.dll''. - -@node Ecrire une extension, Exemple d'extension, Les extensions dans WeeChat, Extensions -@section Ecrire une extension - -@subsection R@`egles de base - -L'extension doit appeler le fichier ``weechat-plugin.h'' (disponible -dans les sources de WeeChat).@* -Ce fichier d@'efinit les structures et types dont l'extension aura -besoin pour communiquer avec WeeChat.@* -@* -L'extension doit comporter certaines variables et fonctions -obligatoires (sans quoi l'extension ne peut être chargée) :@* -@itemize @bullet -@item variables de description de l'extension : -@itemize @minus -@item plugin_name[]: le nom de l'extension -@item plugin_version[]: la version de l'extension -@item plugin_description[]: une courte description de l'extension -@end itemize -@item fonctions d'initialisation et fin de l'extension : -@itemize @minus -@item weechat_plugin_init: fonction appel@'ee au chargement de l'extension, -qui doit renvoyer PLUGIN_RC_OK (0) en cas de succ@`es, PLUGIN_RC_KO (-1) -en cas d'erreur -@item weechat_plugin_end: fonction appel@'ee au d@'echargement de l'extension -@end itemize -@end itemize - -@subsection Fonctions de l'interface (API) - -L'extension peut appeler un certain nombre de fonctions d@'efinies -dans la structure t_weechat_plugin.@* -@* -Ces fonctions sont d@'etaill@'ees ci-dessous :@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Effectue une comparaison entre deux cha@^ines, sans tenir compte des -majuscules/minuscules ni de la locale.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string1}: la premi@`ere cha@^ine @`a comparer -@item @option{string2}: la deuxi@`eme cha@^ine @`a comparer -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La diff@'erence entre les deux cha@^ines: n@'egatif si chaine1 < -chaine2, nul si chaine1 == chaine 2, positif si chaine1 > chaine2@* -@* -@emph{Exemple :}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Effectue une comparaison entre deux cha@^ines, sans tenir compte des -majuscules/minuscules ni de la locale, en comparant au plus ``max'' -caract@`eres.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string1}: la premi@`ere cha@^ine @`a comparer -@item @option{string2}: la deuxi@`eme cha@^ine @`a comparer -@item @option{max}: nombre de caract@`eres max @`a comparer -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La diff@'erence entre les deux cha@^ines: n@'egatif si chaine1 < -chaine2, nul si chaine1 == chaine 2, positif si chaine1 > chaine2@* -@* -@emph{Exemple :}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explose une cha@^ine en plusieurs selon un/des d@'elimiteur(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string}: la cha@^ine @`a exploser -@item @option{separators}: les d@'elimiteurs utilis@'es pour exploser -la cha@^ine -@item @option{num_items_max}: nombre maximum de sous-cha@^ines -cr@'e@'ees (si 0, alors le nombre est infini) -@item @option{num_items}: pointeur vers un entier qui contiendra le -nombre de sous-cha@^ines cr@'e@'ees en retour -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Un tableau de cha@^ines, ou NULL si un probl@^eme a @'et@'e rencontr@'e.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free_exploded_string'' apr@`es utilisation.@* -@* -@emph{Exemple :}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Lib@`ere la m@'emoire utilis@'ee pour une explosion de cha@^ine.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{string}: la cha@^ine explos@'ee par la fonction -``explode_string'' -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Ex@'ecute une fonction sur tous les fichiers d'un r@'epertoire.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{directory}: le r@'epertoire o@`u les fichiers sont -recherch@'es -@item @option{callback}: une fonction appel@'ee pour chaque fichier trouv@'e -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "fichier: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Affiche un message sur un tampon WeeChat, identifi@'e par le serveur et -le canal (tous deux pouvant @^etre NULL pour le tampon courant).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{server}: nom du serveur pour trouver le tampon dans -lequel afficher (peut @^etre NULL) -@item @option{channel}: nom du canal pour trouver le tampon dans -lequel afficher (peut @^etre NULL) -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemples :}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Affiche un message sur la fen@^etre du serveur courant.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Affiche un message sur la barre d'infos pour un temps d@'etermin@'e.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{time}: temps pendant lequel le message est affich@'e, en -secondes (0 = jamais effac@'e) -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Ajoute un gestionnaire de messages IRC, appel@'e d@`es qu'un message -IRC est re@,cu.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{message}: message IRC (par exemple ``PRIVMSG'') -@item @option{handler_func}: fonction appel@'ee lorsque le message est -re@,cu -@item @option{handler_args}: param@`etres pass@'es @`a la fonction -appel@'ee -@item @option{handler_pointer}: pointeur pass@'e @`a la fonction -appel@'ee -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Le pointeur vers le nouveau gestionnaire de messages.@* -@* -@emph{Exemple :}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK re@,cu");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une -des valeurs suivantes (pr@'efix@'ee par ``weechat::'' pour Perl ou -``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: le message ne sera pas transmis -@`a WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: le message ne sera pas transmis -@`a d'autres extensions -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: le message ne sera transmis ni @`a -WeeChat ni @`a d'autres extensions -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Ajoute un gestionnaire de commande WeeChat, appel@'e d@`es que -l'utilisateur utilise la commande (par exemple /commande).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{commande}: la nouvelle commande -@item @option{description}: description de la commande (affich@'ee par -/help commande) -@item @option{arguments}: br@`eve description des param@`etres de la -commande (affich@'ee par /help commande) -@item @option{arguments_description}: longue description des -param@`etres de la commande (affich@'ee par /help commande) -@item @option{completion_template}: mod@`ele pour la compl@'etion, sous -la forme @code{abc|%w def|%i} qui signifie ``abc'' ou une comande -WeeChat pour le premier param@`etre, et ``def'' ou une commande IRC -pour le deuxi@`eme.@* -Les codes suivants peuvent @^etre utilis@'es : -@itemize @minus -@item @code{%-}: aucune compl@'etion pour le param@`etre -@item @code{%a}: alias -@item @code{%A}: alias et commandes (WeeChat, IRC et extensions) -@item @code{%c}: canal courant -@item @code{%C}: canaux du serveur courant -@item @code{%f}: nom de fichier -@item @code{%h}: commandes d@'efinies par des extensions -@item @code{%i}: commandes IRC (envoy@'ees) -@item @code{%I}: commandes IRC (re@,cues) -@item @code{%k}: touches -@item @code{%n}: pseudos du canal courant -@item @code{%o}: option de configuration -@item @code{%p}: message de ``part'' par d@'efaut -@item @code{%q}: message de ``quit'' par d@'efaut -@item @code{%s}: nom du serveur courant -@item @code{%S}: noms de tous les serveurs -@item @code{%t}: titre du canal courant -@item @code{%v}: valeur d'une option de configuration -@item @code{%w}: commandes WeeChat -@item @code{%y}: message d'absence (``away'') par d@'efaut -@end itemize -@item @option{handler_func}: fonction appel@'ee lorsque la commande est -ex@'ecut@'ee -@item @option{handler_args}: param@`etres pass@'es @`a la fonction -appel@'ee -@item @option{handler_pointer}: pointeur pass@'e @`a la fonction -appel@'ee -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Le pointeur vers le nouveau gestionnaire de commande.@* -@* -@emph{Exemple :}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "commande test, -fichier: %s", (arguments) ? arguments : "aucun");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Commande test", -"[fichier]", "fichier: un nom de fichier", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit -renvoyer une des valeurs suivantes (pr@'efix@'ee par ``weechat::'' -pour Perl ou ``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Supprime un gestionnaire.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{handler}: le gestionnaire @`a supprimer -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Supprime tous les gestionnaires d'une extension.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute une commande WeeChat (ou envoie un message @`a un canal).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{server}: nom du serveur o@`u ex@'ecuter la commande -(peut @^etre NULL) -@item @option{channel}: nom du canal o@`u ex@'ecuter la commande (peut -@^etre NULL) -@item @option{command}: la commande @`a ex@'ecuter -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemples :}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Renvoie une information sur WeeChat ou un canal.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{info}: nom de l'info @`a obtenir : -@itemize @minus -@item @option{version}: obtenir la version de WeeChat -@item @option{nick}: obtenir le pseudo -@item @option{channel}: obtenir le nom du canal -@item @option{server}: obtenir le nom du serveur -@item @option{away}: obtenir le drapeau ``away'' -@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat -@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' -syst@`eme de WeeChat -@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' -syst@`eme de partage WeeChat -@end itemize -@item @option{server}: nom du serveur o@`u r@'ecup@'erer l'information -(ni n@'ecessaire) -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -L'information recherch@'ee, NULL si non trouv@'ee.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free'' apr@`es utilisation.@* -@* -@emph{Exemples :}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Renvoie la liste des DCC en cours ou termin@'es.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La liste cha@^in@'ee des DCC.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free_dcc_info'' apr@`es utilisation.@* -@* -@emph{Exemple :}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, avec: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Lib@`ere la m@'emoire utilis@'ee par une liste de DCC.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{dcc_info}: pointeur vers une structure renvoy@'ee par la -fonction ``get_dcc_info'' -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Renvoie la valeur d'une option de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a lire -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, NULL si non trouv@'ee.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free'' apr@`es utilisation.@* -@* -@emph{Exemples :}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_set_title");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Modifie la valeur d'une option de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a mettre @`a jour -@item @option{value}: nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si l'option a @'et@'e modifi@'ee avec succ@`es, 0 si une erreur -s'est produite.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Renvoie la valeur d'une option de l'extension.@* -L'option est lue depuis le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.option=valeur}@* -NB: le nom de l'extension est ajout@'e automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a lire -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, NULL si non trouv@'ee.@* -NB: le r@'esultat doit @^etre lib@'er@'e par un appel @`a la fonction -``free'' apr@`es utilisation.@* -@* -@emph{Exemple :}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "ma_variable");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Modifie la valeur d'une option de l'extension.@* -L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.option=valeur}@* -NB: le nom de l'extension est ajout@'e automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: un pointeur vers la structure de l'extension -@item @option{option}: nom de l'option @`a mettre @`a jour -@item @option{value}: nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si l'option a @'et@'e modifi@'ee avec succ@`es, 0 si une erreur -s'est produite.@* -@* -@emph{Exemple :}@* -@* -@code{plugin->set_plugin_config (plugin, "ma_variable", "valeur");}@* -@* - -@end itemize - -@subsection Compiler l'extension - -La compilation ne n@'ecessite pas les sources WeeChat, mais seulement -le fichier ``weechat-plugin.h''.@* - -Pour compiler une extension compos@'ee d'un fichier ``toto.c'' (sous -GNU/Linux) :@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Charger l'extension dans WeeChat - -Copier le fichier ``libtoto.so'' dans le r@'epertoire des extensions -g@'en@'eral (par exemple /usr/local/lib/weechat/plugins) ou bien dans -celui de l'utilisateur (par exemple /home/xxxxx/.weechat/plugins).@* -@* -Sous WeeChat :@* -@command{/plugin load toto} - -@node Exemple d'extension, Extensions pour scripts, Ecrire une extension, Extensions -@section Exemple d'extension - -Un exemple complet d'extension, qui ajoute une commande /double -affichant deux fois les param@`etres pass@'es sur le canal courant -(d'accord ce n'est pas tr@`es utile mais ceci est un exemple !) :@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Plugin de test pour WeeChat"; - -/* gestionnaire de commande "/hello" */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Affiche deux fois un message", - "msg", - "msg: message a afficher deux fois", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* on ne fait rien ici */ -} -@end verbatim - -@node Extensions pour scripts, , Exemple d'extension, Extensions -@section Extensions pour scripts - -Trois extensions sont fournies en standard avec WeeChat pour utiliser -des langages de script: Perl, Python et Ruby. - -@subsection Charger/d@'echarger des scripts - -Les scripts sont charg@'es et d@'echarg@'es avec les commandes -@command{/perl}, @command{/python} et @command{/ruby}. -(tapez @kbd{/help} dans WeeChat pour obtenir de l'aide sur les -commandes).@* - -@emph{Exemples :}@* -@itemize @bullet -@item -Charger un script Perl : @kbd{/perl load /tmp/essai.pl}@* -@item -D@'echarger tous les scripts Perl : @kbd{/perl unload}@* -@item -Lister les scripts Perl charg@'es : @kbd{/perl}@* -@item -Charger un script Python : @kbd{/python load /tmp/essai.py}@* -@item -D@'echarger tous les scripts Python : @kbd{/python unload}@* -@item -Lister les scripts Python charg@'es : @kbd{/python}@* -@end itemize - -@subsection Interface WeeChat / Scripts - -@itemize @bullet -@item -Perl: @command{weechat::register ( nom, version, fonction_de_fin, -description );}@* -Python: @command{weechat.register ( nom, version, fonction_de_fin, -description )}@* -@* -C'est la premi@`ere fonction @`a appeler dans le script.@* -Tout script 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 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{Valeur renvoy@'ee :}@* -@* -1 si le script a @'et@'e enregistr@'e, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::register ("essai", "1.0", "fin_essai", "Script d'essai !");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.register ("essai", "1.0", "fin_essai", "Script d'essai !")}@* -@* - -@item -Perl: @command{weechat::print ( message, [canal, [serveur]] );}@* -Python: @command{weechat.prnt ( message, [canal, [serveur]] )}@* -@* -Affiche un message dans un canal.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{message}: message @`a afficher -@item @option{canal}: nom du canal -@item @option{serveur}: nom interne du serveur -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( d@'elai, message );}@* -Python: @command{weechat.print_infobar ( d@'elai, message )}@* -@* -Affiche un message dans la barre d'infos.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{d@'elai}: d@'elai (en secondes) pendant lequel le message est affich@'e -(si 0, le message ne sera pas effac@'e). -@item @option{message}: message @`a afficher -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( nom, fonction );}@* -Python: @command{weechat.add_message_handler ( nom, fonction )}@* -@* -Attache une fonction @`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 appel@'ee lorsque le message est re@,{c}u -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si la fonction a @'et@'e attach@'ee, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::add_message_handler ("privmsg", ma_fonction);}@* -@code{sub ma_fonction}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("serveur=$_[0]\n");}@* -@code{@ @ @ @ ($null, $canal, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($masque, $null, $canal) = split " ", $canal;}@* -@code{@ @ @ @ weechat::print ("masque=$masque, canal=$canal, msg=$message\n");}@* -@code{@ @ @ @ return weechat::PLUGIN_RC_OK;}@* -@code{@} }@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.add_message_handler ("privmsg", ma_fonction)}@* -@code{def ma_fonction(serveur, args):}@* -@code{@ @ @ @ weechat.prnt("serveur="+serveur)}@* -@code{@ @ @ @ null, canal, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ masque, null, canal = string.split(string.strip(canal), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("masque="+masque+", canal="+canal+", message="+message)}@* -@code{@ @ @ @ return weechat.PLUGIN_RC_OK}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque le message est re@,cu doit renvoyer une -des valeurs suivantes (pr@'efix@'ee par ``weechat::'' pour Perl ou -``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: le message ne sera pas -transmis @`a WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: le message ne sera pas -transmis @`a d'autres extensions -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: le message ne sera transmis ni -@`a WeeChat ni @`a d'autres extensions -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( nom, fonction, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( nom, fonction, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Cr@'e@'e une nouvelle commande WeeChat, associ@'ee @`a une fonction.@* -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 du script. Soyez prudent en @'ecrasant les -commandes WeeChat, car elles ne seront plus accessibles tant que le -script sera charg@'e. -@item @option{fonction}: fonction associ@'ee @`a la commande -@item @option{description}: description de la commande (affich@'ee par -/help commande) -@item @option{arguments}: br@`eve description des param@`etres de la -commande (affich@'ee par /help commande) -@item @option{arguments_description}: longue description des -param@`etres de la commande (affich@'ee par /help commande) -@item @option{completion_template}: mod@`ele pour la compl@'etion, sous -la forme @code{abc|%w def|%i} qui signifie ``abc'' ou une comande -WeeChat pour le premier param@`etre, et ``def'' ou une commande IRC -pour le deuxi@`eme.@* -Les codes suivants peuvent @^etre utilis@'es : -@itemize @minus -@item @code{%-}: aucune compl@'etion pour le param@`etre -@item @code{%a}: alias -@item @code{%A}: alias et commandes (WeeChat, IRC et extensions) -@item @code{%c}: canal courant -@item @code{%C}: canaux du serveur courant -@item @code{%f}: nom de fichier -@item @code{%h}: commandes d@'efinies par des extensions -@item @code{%i}: commandes IRC (envoy@'ees) -@item @code{%I}: commandes IRC (re@,cues) -@item @code{%k}: touches -@item @code{%n}: pseudos du canal courant -@item @code{%o}: option de configuration -@item @code{%p}: message de ``part'' par d@'efaut -@item @code{%q}: message de ``quit'' par d@'efaut -@item @code{%s}: nom du serveur courant -@item @code{%S}: noms de tous les serveurs -@item @code{%t}: titre du canal courant -@item @code{%v}: valeur d'une option de configuration -@item @code{%w}: commandes WeeChat -@item @code{%y}: message d'absence (``away'') par d@'efaut -@end itemize -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si la fonction a @'et@'e attach@'ee, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::add_command_handler ("commande", ma_commande);}@* -@code{sub ma_commande}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Serveur: $_[0], param@`etres: $_[1]\n");}@* -@code{@ @ @ @ return weechat::PLUGIN_RC_OK;}@* -@code{@} }@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.add_command_handler ("commande", ma_commande)}@* -@code{def ma_commande(serveur, args):}@* -@code{@ @ @ @ weechat.prnt("serveur:"+serveur+" param@`etres:"+args)}@* -@code{@ @ @ @ return weechat.PLUGIN_RC_OK}@* -@* -@emph{Notes :}@* -@* -La fonction appel@'ee lorsque la commande est ex@'ecut@'ee doit -renvoyer une des valeurs suivantes (pr@'efix@'ee par ``weechat::'' -pour Perl ou ``weechat.'' pour Python) :@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: la fonction a @'echou@'e -@item @option{PLUGIN_RC_OK}: la fonction a r@'eussi -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( nom, fonction );}@* -Python: @command{weechat.remove_handler ( nom, fonction )}@* -@* -Supprime un gestionnaire de message ou de commande.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{nom}: nom du message IRC ou de la commande -@item @option{fonction}: fonction associ@'ee -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::remove_handler ("commande", ma_commande);}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.remove_handler ("commande", ma_commande)}@* -@* - -@item -Perl: @command{weechat::command ( commande, [canal, [serveur]] );}@* -Python: @command{weechat.command ( commande, [canal, [serveur]] )}@* -@* -Ex@'ecute une commande ou envoie un message @'a un canal.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{commande}: commande @'a ex@'ecuter (ou message @'a -envoyer au canal) -@item @option{canal}: nom du canal -@item @option{serveur}: nom interne du serveur -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{weechat::command ("bonjour tout le monde !");}@* -@code{weechat::command ("/kick toto merci de quitter ce canal", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{weechat.command ("bonjour tout le monde !")}@* -@code{weechat.command ("/kick toto merci de quitter ce canal", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( nom, [serveur] );}@* -Python: @command{weechat.get_info ( nom, [serveur] )}@* -@* -Obtenir des informations vari@'ees sur WeeChat, le serveur ou -l'utilisateur.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{nom}: nom de l'info @`a obtenir : -@itemize @minus -@item @option{version}: obtenir la version de WeeChat -@item @option{nick}: obtenir le pseudo -@item @option{channel}: obtenir le nom du canal -@item @option{server}: obtenir le nom du serveur -@item @option{away}: obtenir le drapeau ``away'' -@item @option{weechat_dir}: obtenir le r@'epertoire maison de WeeChat -@item @option{weechat_libdir}: obtenir le r@'epertoire ``lib'' -syst@`eme de WeeChat -@item @option{weechat_sharedir}: obtenir le r@'epertoire ``share'' -syst@`eme de partage WeeChat -@end itemize -@item @option{serveur}: nom interne du serveur -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -L'information demand@'e, blanc si une erreur s'est produite ou que -l'information n'a pas @'et@'e trouv@'ee.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{$version = get_info("version");}@* -@code{$nick = get_info("nick", "freenode");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{$version = weechat.get_info ("version")}@* -@code{$nick = weechat.get_info ("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( )}@* -@* -Obtenir la liste des DCC.@* - -Le tableau renvoy@'e contient les champs suivants : -@itemize @minus -@item server: le serveur IRC -@item channel: le canal IRC -@item type: le type de DCC : -@itemize @minus -@item 0: discussion (re@,cue) -@item 1: discussion (envoy@'ee) -@item 2: fichier en r@'eception -@item 3: fichier en @'emission -@end itemize -@item status: statut du DCC : -@itemize @minus -@item 0: en attente -@item 1: en cours de connexion -@item 2: actif -@item 3: termin@'e -@item 4: @'echou@'e -@item 5: interrompu par l'utilisateur -@end itemize -@item start_time: la date et heure de cr@'eation du DCC -@item start_transfer: la date et heure de d@'emarrage du transfert -@item addr: adresse de l'utilisateur distant -@item port: port utilis@'e pour le DCC -@item nick: pseudo de l'utilisateur distant -@item filename: nom de fichier -@item local_filename: nom de fichier local -@item size: taille du fichier -@item pos: position actuelle dans le fichier -@item start_resume: position de d@'emarrage apr@`es une interruption -@item bytes_per_sec: nombre d'octets transmis par seconde depuis le d@'ebut -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La liste des DCC, 0 si une erreur s'est produite.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Obtenir la valeur d'une option de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, blanc si une erreur s'est produite ou que -l'option n'a pas @'et@'e trouv@'ee.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, valeur );}@* -Python: @command{weechat.set_config ( option, valeur )}@* -@* -Modifier une otion de configuration WeeChat.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@item @option{valeur}: la nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemples en Perl :}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin, "#weechat");}@* -@* -@emph{Exemples en Python :}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin, "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Renvoie la valeur d'une option de l'extension.@* -L'option est lue depuis le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.script.option=valeur}@* -NB: le nom de l'extension et du script sont ajout@'es automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -La valeur de l'option, blanc si une erreur s'est produite ou que -l'option n'a pas @'et@'e trouv@'ee.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{$value = weechat::get_plugin_config ("ma_variable");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{$value = weechat.get_plugin_config ("ma_variable")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, valeur );}@* -Python: @command{weechat.set_plugin_config ( option, valeur )}@* -@* -Modifie la valeur d'une option de l'extension.@* -L'option est @'ecrite dans le fichier ~/.weechat/plugins.rc et est -sous cette forme :@* -@code{extension.script.option=valeur}@* -NB: le nom de l'extension et du script sont ajout@'es automatiquement.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{option}: nom de l'option -@item @option{valeur}: la nouvelle valeur pour l'option -@end itemize -@* -@emph{Valeur renvoy@'ee :}@* -@* -1 si succ@`es, 0 si une erreur s'est produite.@* -@* -@emph{Exemple en Perl :}@* -@* -@code{weechat::set_plugin_config ("ma_variable", "valeur");}@* -@* -@emph{Exemple en Python :}@* -@* -@code{weechat.set_plugin_config ("ma_variable", "valeur")}@* -@* - -@end itemize - - -@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}> - -@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 : @uref{http://forums.flashtux.org}@*@* -@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{} 2005 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 deleted file mode 100644 index f2492f758..000000000 --- a/weechat/doc/weechat_doc_pt.texi +++ /dev/null @@ -1,2907 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename weechat_doc_pt.info -@settitle WeeChat - Um cliente de IRC rapido, leve e extencivel -@c %**end of header - -@c WeeChat documentation (vers@~ao partuguesa) -@c -@c Copyright (c) 2005 by FlashCode <flashcode@flashtux.org> -@c -@c This manual is free software; you can redistribute it and/or modify -@c it under the terms of the GNU General Public License as published by -@c the Free Software Foundation; either version 2 of the License, or -@c (at your option) any later version. -@c -@c This manual is distributed in the hope that it will be useful, -@c but WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with this program; if not, write to the Free Software -@c Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -@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 -@documentencoding ISO-8859-1 - -@titlepage - -@title WeeChat - Guia do Utilizador -@subtitle Cliente de IRC rapido, leve e extencivel -@subtitle Documenta@,{c}@~ao do WeeChat v0.1.7-cvs - 16 de dezembro de 2005 - -@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{} 2005 FlashCode -<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* -@* -Este documento pode ser utilizado sobre os termos da Licen@,{c}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, Introducao, (dir), (dir) -@menu -* Introducao:: Descri@,{c}@~ao do WeeChat -* Instalacao:: Instala@,{c}@~ao do WeeChat -* Utilizacao:: Utiliza@,{c}@~ao do WeeChat -* Plugins:: WeeChat plugins -* Autores/Suporte:: Contactar os autores e obter suporte -@end menu - - -@c ******************************* Introducao ******************************* - -@node Introducao, Instalacao, Top, Top -@chapter Introdu@,{c}@~ao -@menu -* Descricao:: -* Pre-requisitos:: -@end menu - -@node Descricao, Pre-requisitos, Introducao, Introducao -@section Descri@,{c}@~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 (com SSL, IPv6, proxy) -@item -v@'arias interfaces : Curses, wxWidgets, 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, MacOS X, 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, ,Descricao, Introducao -@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 ******************************* Instalacao ******************************* - -@node Instalacao, Utilizacao, Introducao, Top -@chapter Instala@,{c}@~ao -@menu -* Binarios:: -* Codigo Fonte:: -* Codigo Fonte via CVS:: -@end menu - -@node Binarios, Codigo Fonte, Instalacao, Instalacao -@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{apt-get install weechat-curses} -@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 : @kbd{emerge weechat} -@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, Instalacao -@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, Instalacao -@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 ******************************* Utilizacao ******************************** - -@node Utilizacao, Plugins, Instalacao, Top -@chapter Utiliza@,{c}@~ao - -@menu -* Invocar o WeeChat:: -* Config file:: -* Recursos de teclado:: -* Comandos do WeeChat:: -* FIFO pipe:: -@end menu - -@node Invocar o WeeChat, Config file, Utilizacao, Utilizacao -@section Invocar o WeeChat - -@subsection Par@^ametros de linha de comandos - -@table @code -@item -a, --no-connect -Disable auto-connect to servers at startup@* -@item -c, --config -Mostrar da lima dos config da exposi@,{c}@~ao (lista das op@,{c}@~oes) -@item -f, --key-functions -Display WeeChat internal functions for keys@* -@item -h, --help -Mostrar a ajuda@* -@item -i, --irc-commands -Display IRC commands list@* -@item -k, --keys -Display WeeChat default keys@* -@item -l, --license -Mostrar a licen@,{c}a do WeeChat@* -@item -p, --no-plugin -Don't load any plugin at startup -@item -v, --version -Mostrar a vers@~ao do WeeChat@* -@item -w, --weechat-commands -Display WeeChat commands list@* -@end table - -@subsection Invocar o WeeChat - -Escreve simplesmente este comando para invoceres o WeeChat :@* -@kbd{weechat-curses} (para a interface em Curses)@* -ou @kbd{weechat-wxwidgets} (para a interface em wxWidgets)@* -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 Config file, Recursos de teclado, Invocar o WeeChat, Utilizacao -@section Config file - -List of options for config file:@* - -@table @kbd -@item look_set_title -Set title for window (terminal for Curses GUI) with name & version@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_logo -Display WeeChat logo at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_startup_version -Display WeeChat version at startup@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_weechat_slogan -WeeChat slogan (if empty, slogan is not used)@* -Type: string (any string), default value: 'the geekest IRC client!'@* -@item look_charset_decode_iso -ISO charset for decoding messages from server (used only if locale is UTF-8) (if empty, messages are not converted if locale is UTF-8@* -Type: string (any string), default value: 'ISO-8859-1'@* -@item look_charset_decode_utf -UTF charset for decoding messages from server (used only if locale is not UTF-8) (if empty, messages are not converted if locale is not UTF-8@* -Type: string (any string), default value: 'UTF-8'@* -@item look_charset_encode -Charset for encoding messages sent to server, examples: UFT-8, ISO-8859-1 (if empty, messages are not converted)@* -Type: string (any string), default value: ''@* -@item look_charset_internal -Forces internal WeeChat charset (should be empty in most cases, that means detected charset is used)@* -Type: string (any string), default value: ''@* -@item look_one_server_buffer -Use same buffer for all servers@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item look_buffer_timestamp -Timestamp for buffers@* -Type: string (any string), default value: '[%H:%M:%S]'@* -@item look_color_nicks_number -Number of colors to use for nicks colors@* -Type: integer (values: between 1 and 10), default value: 10@* -@item look_color_actions -Display actions with different colors@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist -Display nicklist window (for channel windows)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nicklist_position -Nicklist position (top, left, right (default), bottom)@* -Type: string (values: 'left', 'right', 'top', 'bottom'), default value: 'right'@* -@item look_nicklist_min_size -Min size for nicklist (width or height, depending on look_nicklist_position (0 = no min size))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_nicklist_max_size -Max size for nicklist (width or height, depending on look_nicklist_position (0 = no max size; if min == max and > 0, then size is fixed))@* -Type: integer (values: between 0 and 100), default value: 0@* -@item look_no_nickname -Text to display instead of nick when not connected@* -Type: string (any string), default value: '-cmd-'@* -@item look_nickmode -Display nick mode ((half)op/voice) before each nick@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_nickmode_empty -Display space if nick mode is not (half)op/voice@* -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_nick_completion_ignore -Chars ignored for nick completion@* -Type: string (any string), default value: '[]-^'@* -@item look_infobar -Enable info bar@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_timestamp -Timestamp for time in infobar@* -Type: string (any string), default value: '%B, %A %d %Y'@* -@item look_infobar_seconds -Display seconds in infobar time@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_infobar_delay_highlight -Delay (in seconds) for highlight messages in infobar (0 = disable highlight notifications in infobar)@* -Type: integer (values: between 0 and 2147483647), default value: 7@* -@item look_hotlist_names_count -Max number of names in hotlist (0 = no name displayed, only buffer numbers)@* -Type: integer (values: between 0 and 32), default value: 3@* -@item look_hotlist_names_level -Level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)@* -Type: integer (values: between 1 and 15), default value: 12@* -@item look_hotlist_names_length -Max length of names in hotlist (0 = no limit)@* -Type: integer (values: between 0 and 32), default value: 0@* -@item look_day_change -Display special message when day changes@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item look_day_change_timestamp -Timestamp for date displayed when day changed@* -Type: string (any string), default value: '%a, %d %b %Y'@* -@item look_read_marker -Use a marker on servers/channels to show first unread line@* -Type: string (any string), default value: ' '@* -@item col_real_white -If set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item col_title -Color for title bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_title_bg -Background for title bar@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_chat -Color for chat text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time -Color for time in chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_time_sep -Color for time separator (chat window)@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_prefix1 -Color for 1st and 3rd char of prefix@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_prefix2 -Color for middle char of prefix@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_server -Color for server name@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_chat_join -Color for join arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_chat_part -Color for part/quit arrow (prefix)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_chat_nick -Color for nicks in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_chat_host -Color for hostnames (chat window)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_chat_channel -Color for channel names in actions (chat window)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_chat_dark -Color for dark separators (chat window)@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_chat_highlight -Color for highlighted nick (chat window)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_bg -Background for chat window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_chat_read_marker -Color for unread data marker@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_chat_read_marker_bg -Background for unread data marker@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_status -Color for status bar@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_delimiters -Color for status bar delimiters@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_status_channel -Color for current channel in status bar@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_data_msg -Color for window with new messages (status bar)@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_status_private -Color for window with private message (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_status_highlight -Color for window with highlight (status bar)@* -Type: color (Curses or Gtk color), default value: 'lightred'@* -@item col_status_data_other -Color for window with new data (not messages) (status bar)@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_status_more -Color for window with new data (status bar)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_status_bg -Background for status window@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar -Color for info bar text@* -Type: color (Curses or Gtk color), default value: 'black'@* -@item col_infobar_delimiters -Color for infobar delimiters@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_infobar_highlight -Color for info bar highlight notification@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_infobar_bg -Background for info bar window@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input -Color for input text@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_input_channel -Color for input text (channel name)@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_input_nick -Color for input text (nick name)@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_input_delimiters -Color for input text (delimiters)@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_input_bg -Background for input window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick -Color for nicknames@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_away -Color for away nicknames@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_chanowner -Color for chan owner symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_chanadmin -Color for chan admin symbol (specific to unrealircd)@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_op -Color for operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_halfop -Color for half-operator symbol@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_voice -Color for voice symbol@* -Type: color (Curses or Gtk color), default value: 'yellow'@* -@item col_nick_more -Color for '+' when scrolling nicks@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_sep -Color for nick separator@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_self -Color for local nick@* -Type: color (Curses or Gtk color), default value: 'white'@* -@item col_nick_color1 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'cyan'@* -@item col_nick_color2 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'magenta'@* -@item col_nick_color3 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'green'@* -@item col_nick_color4 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'brown'@* -@item col_nick_color5 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightblue'@* -@item col_nick_color6 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'default'@* -@item col_nick_color7 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightcyan'@* -@item col_nick_color8 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightmagenta'@* -@item col_nick_color9 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'lightgreen'@* -@item col_nick_color10 -Color for nick@* -Type: color (Curses or Gtk color), default value: 'blue'@* -@item col_nick_private -Color for other nick in private window@* -Type: color (Curses or Gtk color), default value: 'default'@* -@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: 'lightcyan'@* -@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 history_display_default -Maximum number of commands to display by default in history listing (0 = unlimited)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item log_auto_server -Automatically log server messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_channel -Automatically log channel chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_auto_private -Automatically log private chats@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_plugin_msg -Log messages from plugins (scripts)@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item log_path -Path for WeeChat log files@* -Type: string (any string), default value: '~/.weechat/logs/'@* -@item log_timestamp -Timestamp for log (see man strftime for date/time specifiers)@* -Type: string (any string), default value: '%Y %b %d %H:%M:%S'@* -@item log_hide_nickserv_pwd -Hide password displayed by nickserv@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_display_away -Display message to all channels when (un)marking as away@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_default_msg_away -Default message when away@* -Type: string (any string), default value: 'away'@* -@item irc_default_msg_part -Default part message (leaving channel)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_default_msg_quit -Default quit message ('%v' will be replaced by WeeChat version in string)@* -Type: string (any string), default value: 'WeeChat %v'@* -@item irc_notice_as_pv -Display notices as private messages@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_away_check -Interval between two checks for away (in minutes, 0 = never check)@* -Type: integer (values: between 0 and 2147483647), default value: 0@* -@item irc_lag_check -Interval between two checks for lag (in seconds)@* -Type: integer (values: between 30 and 2147483647), default value: 60@* -@item irc_lag_min_show -Minimum lag to show (in seconds)@* -Type: integer (values: between 0 and 2147483647), default value: 1@* -@item irc_lag_disconnect -Disconnect after important lag (in minutes, 0 = never disconnect)@* -Type: integer (values: between 0 and 2147483647), default value: 5@* -@item irc_fifo_pipe -Create a FIFO pipe for remote control@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item irc_highlight -Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)@* -Type: string (any string), default value: ''@* -@item irc_colors_receive -When off, colors codes are ignored in incoming messages@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item irc_colors_send -Allow user to send colors with special codes (%B=bold, %Cxx,yy=color, %U=underline, %R=reverse)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_accept_files -Automatically accept incoming dcc files@* -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: 'off'@* -@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: 65536)@* -Type: integer (values: between 1024 and 102400), default value: 65536@* -@item dcc_port_range -Restricts outgoing dcc to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port)@* -Type: string (any string), default value: ''@* -@item dcc_own_ip -IP or DNS address used for outgoing dcc (if empty, local interface IP is used)@* -Type: string (any string), default value: ''@* -@item dcc_download_path -Path for writing incoming files with dcc (default: user home)@* -Type: string (any string), default value: '~'@* -@item dcc_upload_path -Path for reading files when sending thru dcc (when no path is specified)@* -Type: string (any string), default value: '~'@* -@item dcc_convert_spaces -Convert spaces to underscores when sending files@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_rename -Rename incoming files if already exists (add '.1', '.2', ...)@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item dcc_auto_resume -Automatically resume dcc transfer if connection with remote host is loosed@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item proxy_use -Use a proxy server to connect to irc server@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_type -Proxy type (http (default), socks4, socks5)@* -Type: string (values: 'http', 'socks4', 'socks5'), default value: 'http'@* -@item proxy_ipv6 -Connect to proxy in ipv6@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item proxy_address -Proxy server address (IP or hostname)@* -Type: string (any string), default value: ''@* -@item proxy_port -Port for connecting to proxy server@* -Type: integer (values: between 0 and 65535), default value: 3128@* -@item proxy_username -Username for proxy server@* -Type: string (any string), default value: ''@* -@item proxy_password -Password for proxy server@* -Type: string (any string), default value: ''@* -@item plugins_path -Path for searching plugins@* -Type: string (any string), default value: '~/.weechat/plugins'@* -@item plugins_autoload -Comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "libperl.so")@* -Type: string (any string), default value: '*'@* -@item plugins_extension -Standard plugins extension in filename, used for autoload (if empty, then all files are loaded when autoload is "*")@* -Type: string (any string), default value: '.so'@* -@item server_name -Name associated to IRC server (for display only)@* -Type: string (any string), default value: ''@* -@item server_autoconnect -Automatically connect to server when WeeChat is starting@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect -Automatically reconnect to server when disconnected@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_autoreconnect_delay -Delay (in seconds) before trying again to reconnect to server@* -Type: integer (values: between 0 and 65535), default value: 30@* -@item server_address -IP address or hostname of IRC server@* -Type: string (any string), default value: ''@* -@item server_port -Port for connecting to server@* -Type: integer (values: between 0 and 65535), default value: 6667@* -@item server_ipv6 -Use IPv6 protocol for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_ssl -Use SSL for server communication@* -Type: boolean (values: 'on' or 'off'), default value: 'off'@* -@item server_password -Password for IRC server@* -Type: string (any string), default value: ''@* -@item server_nick1 -Nickname to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_nick2 -Alternate nickname to use on IRC server (if nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_nick3 -2nd alternate nickname to use on IRC server (if alternate nickname is already used)@* -Type: string (any string), default value: ''@* -@item server_username -User name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_realname -Real name to use on IRC server@* -Type: string (any string), default value: ''@* -@item server_command -First command to run when connected to server@* -Type: string (any string), default value: ''@* -@item server_command_delay -Delay (in seconds) after command was executed (example: give some time for authentication)@* -Type: integer (values: between 0 and 5), default value: 0@* -@item server_autojoin -Comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")@* -Type: string (any string), default value: ''@* -@item server_autorejoin -Automatically rejoin channels when kicked@* -Type: boolean (values: 'on' or 'off'), default value: 'on'@* -@item server_notify_levels -Comma separated list of notify levels for channels of this server (format: #channel:1,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_iso -Comma separated list of charsets for server and channels, to decode ISO (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_decode_utf -Comma separated list of charsets for server and channels, to decode UTF (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@item server_charset_encode -Comma separated list of charsets for server and channels, to encode messages (format: server:charset,#channel:charset,..)@* -Type: string (any string), default value: ''@* -@end table - -Colors for Curses GUI are:@* -@itemize @minus -@item -@kbd{default}: default color (transparent for background) -@item -@kbd{black}: black -@item -@kbd{red}: dark red -@item -@kbd{lightred}: light red -@item -@kbd{green}: dark green -@item -@kbd{lightgreen}: light green -@item -@kbd{brown}: brown -@item -@kbd{yellow}: yellow -@item -@kbd{blue}: dark blue -@item -@kbd{lightblue}: light blue -@item -@kbd{magenta}: dark magenta -@item -@kbd{lightmagenta}: light magenta -@item -@kbd{cyan}: dark cyan -@item -@kbd{lightcyan}: light cyan -@item -@kbd{white}: white -@end itemize - -@node Recursos de teclado, Comandos do WeeChat, Config file, Utilizacao -@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 / Ctrl + A -Ir para o in@'icio da linha de comando@* -@* -@item End / Ctrl + E -Ir para o fim da linha de comando@* -@* -@item Ctrl + K -Delete until end of line@* -@* -@item Ctrl + L -Redesenhe a janela inteira@* -@* -@item Ctrl + U -Delete until beginning of line@* -@* -@item Ctrl + W -Apagar a palavra anterior na linha de comando -@* -@item Backspace / Delete -Apagar o caractere anterior / seguinte 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 Ctrl + up arrow / Ctrl + down arrow -Call again last commands/messages in global history@* -@* -@item PageUp / PageDown -Navegar no hist@'orico da janela@* -@* -@item F5 / F6 -Comute ao amortecedor anterior / seguinte@* -@* -@item F7 / F8 -Comute ao janela anterior / seguinte@* -@* -@item F10 -Apagar a @'ultima mensagem da barra do info@* -@* -@item F11 / F12 -Scroll nicklist@* -@* -@item Alt + Seta da esquerda / Alt + Seta da direita -Identico a F5 / F6@* -@* -@item Alt + A -Comute ao amortecedor seguinte com atividade (com prioridade: destaque, mensagem, outra)@* -@* -@item Alt + B -Go to previous word@* -@* -@item Alt + D -Delete next word@* -@* -@item Alt + F -Go to next word@* -@* -@item Alt + H -Hotlist desobstru@'ido (notifica@,{c}@~ao da atividade em outros amortecedores)@* -@* -@item Alt + J then Alt + D -Exposi@,{c}@~ao DCC atual@* -@* -@item Alt + J then Alt + L -Switch to last buffer@* -@* -@item Alt + J then Alt + S -Comute ao amortecedor do servidor@* -@* -@item Alt + J then Alt + X -Comute @`a primeira canaleta do servidor seguinte (ou do amortecedor do servidor se nenhuma canaleta for aberta)@* -@* -@item Alt + d@'igito (1-9) -Comute ao amortecedor pelo n@'umero@* -@* -@item Alt + J then number (01-99) -Comute ao amortecedor pelo n@'umero@* -@* -@item Alt + K -Grab a key -@* -@item Alt + N -Scroll to next highlight@* -@* -@item Alt + P -Scroll to previous highlight@* -@* -@item Alt + R -Delete entire line@* -@* -@item Alt + S -Switch server on servers buffer@* -(if option ``look_one_server_buffer'' is enabled)@* -@* -@item Alt + U -Scroll to first unread line in buffer@* -@* -@item Alt + W then Alt + arrow -Switch to window with direction@* -@* -@item Alt + PageUp / Alt + PageDown / Alt + Home / Alt + End -Scroll nicklist@* -@* -@end table - -@node Comandos do WeeChat, FIFO pipe, Recursos de teclado, Utilizacao -@section Comandos do WeeChat - -WeeChat internal commands:@* - -@table @kbd -@item alias [alias_name [command [arguments]] -@* -create an alias for a command@* -@* -alias_name: name of alias@* -command: command name (WeeChat or IRC command, without first '/')@* -arguments: arguments for command@* -@* -@item buffer [action | number | [[server] [channel]]] -@* -manage buffers@* -@* -action: action to do:@* - move: move buffer in the list (may be relative, for example -1)@* - close: close buffer (for channel: same as /part without part message)@* - list: list opened buffers (no parameter implies this list)@* - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)@* -server,channel: jump to buffer by server and/or channel name@* -number: jump to buffer by number@* -@* -@item charset [(decode_iso | decode_utf | encode) charset] -@* -change charset for server or channel@* -@* -decode_iso: charset used for decoding ISO@* -decode_utf: charset used for decoding UTF@* - encode: charset used for encoding messages@* - charset: charset to use (for example: ISO-8859-15, UTF-8,..)@* -@* -@item clear [-all] -@* -clear window(s)@* -@* --all: clear all windows@* -@* -@item connect [servername] -@* -connect to a server@* -@* -servername: server name to connect@* -@* -@item disconnect [servername] -@* -disconnect from a server@* -@* -servername: server name to disconnect@* -@* -@item debug dump | windows -@* -print debug messages@* -@* -dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)@* -windows: display windows tree@* -@* -@item help [command] -@* -display help about commands@* -@* -command: name of a WeeChat or IRC command@* -@* -@item history [clear | value] -@* -show buffer command history@* -@* -clear: clear history@* -value: number of history entries to show@* -@* -@item ignore [mask [[type | command] [channel [server]]]] -@* -ignore IRC messages and/or hosts@* -@* - mask: nick or host mask to ignore@* - type: type of message to ignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for ignore@* - server: name of server for ignore@* -@* -For each argument, '*' means all.@* -Without argument, /ignore command lists all defined ignore.@* -@* -@item key [key function/command] [unbind key] [functions] [reset -yes] -@* -bind/unbind keys@* -@* -key: bind this key to an internal function or a command (beginning by "/")@* -unbind: unbind a key (if "all", default bindings are restored)@* -functions: list internal functions for key bindings@* -reset: restore bindings to the default values and delete ALL personal binding (use carefully!)@* -@* -@item plugin [load filename] | [autoload] | [reload] | [unload] -@* -list/load/unload plugins@* -@* -filename: WeeChat plugin (file) to load@* -@* -Without argument, /plugin command lists all loaded plugins.@* -@* -@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] -@* -list, add or remove servers@* -@* -servername: server name, for internal & display use@* -hostname: name or IP address of server@* -port: port for server (integer)@* -ipv6: use IPv6 protocol@* -ssl: use SSL protocol@* -password: password for server@* -nick1: first nick for server@* -nick2: alternate nick for server@* -nick3: second alternate nick for server@* -username: user name@* -realname: real name of user@* -@* -@item save [file] -@* -save config to disk@* -@* -file: filename for writing config@* -@* -@item set [option [ = value]] -@* -set config parameters@* -@* -option: name of an option (if name is full and no value is given, then help is displayed on option)@* -value: value for option@* -@* -@item unalias alias_name -@* -remove an alias@* -@* -alias_name: name of alias to remove@* -@* -@item unignore [number | [mask [[type | command] [channel [server]]]]] -@* -unignore IRC messages and/or hosts@* -@* - number: # of ignore to unignore (number is displayed by list of ignore)@* - mask: nick or host mask to unignore@* - type: type of message to unignore (action, ctcp, dcc, pv)@* -command: IRC command@* -channel: name of channel for unignore@* - server: name of server for unignore@* -@* -For each argument, '*' means all.@* -Without argument, /unignore command lists all defined ignore.@* -@* -@item upgrade -@* -upgrade WeeChat without disconnecting from servers@* -@* -@item uptime [-o] -@* -show WeeChat uptime@* -@* --o: send uptime on current channel as an IRC message@* -@* -@item window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]] -@* -manage windows@* -@* -list: list opened windows (no parameter implies this list)@* --1: jump to previous window@* -+1: jump to next window@* -b#: jump to next window displaying buffer number #@* -up: switch to window above current one@* -down: switch to window below current one@* -left: switch to window on the left@* -right: switch to window on the right@* -splith: split current window horizontally@* -splitv: split current window vertically@* -resize: resize window size, new size is <pct>%% of parent window@* -merge: merge window with another (all = keep only one window)@* -@* -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4@* -@* -@end table - -IRC commands:@* - -@table @kbd -@item admin [target] -@* -find information about the administrator of the server@* -@* -target: server@* -@* -@item ame message -@* -send a CTCP action to all channels of all connected servers@* -@* -message: message to send@* -@* -@item amsg text -@* -send message to all channels of all connected servers@* -@* -text: text to send@* -@* -@item away [-all] [message] -@* -toggle away status@* -@* --all: toggle away status on all connected servers@* -message: message for away (if no message is given, away status is removed)@* -@* -@item ban [channel] [nickname [nickname ...]] -@* -bans nicks or hosts@* -@* -channel: channel for ban@* -nickname: user or host to ban@* -@* -@item ctcp nickname type [arguments] -@* -send a CTCP message (Client-To-Client Protocol)@* -@* -nickname: user to send CTCP to@* -type: CTCP type (examples: "version", "ping", ..)@* -arguments: arguments for CTCP@* -@* -@item dcc action [nickname [file]] -@* -starts DCC (file or chat) or close chat@* -@* -action: 'send' (file) or 'chat' or 'close' (chat)@* -nickname: nickname to send file or chat@* -file: filename (on local host)@* -@* -@item dehalfop [nickname [nickname]] -@* -removes half channel operator status from nickname(s)@* -@* -@item deop [nickname [nickname]] -@* -removes channel operator status from nickname(s)@* -@* -@item devoice [nickname [nickname]] -@* -removes voice from nickname(s)@* -@* -@item die -@* -shutdown the server@* -@* -@item halfop [nickname [nickname]] -@* -gives half channel operator status to nickname(s)@* -@* -@item info [target] -@* -get information describing the server@* -@* -target: server name@* -@* -@item invite nickname channel -@* -invite a nick on a channel@* -@* -nickname: nick to invite@* -channel: channel to invite@* -@* -@item ison nickname [nickname ...] -@* -check if a nickname is currently on IRC@* -@* -nickname: nickname@* -@* -@item join channel[,channel] [key[,key]] -@* -join a channel@* -@* -channel: channel name to join@* -key: key to join the channel@* -@* -@item kick [channel] nickname [comment] -@* -forcibly remove a user from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick@* -comment: comment for kick@* -@* -@item kickban [channel] nickname [comment] -@* -kicks and bans a nick from a channel@* -@* -channel: channel where user is@* -nickname: nickname to kick and ban@* -comment: comment for kick@* -@* -@item kill nickname comment -@* -close client-server connection@* -@* -nickname: nickname@* -comment: comment for kill@* -@* -@item links [[server] server_mask] -@* -list all servernames which are known by the server answering the query@* -@* -server: this server should answer the query@* -server_mask: list of servers must match this mask@* -@* -@item list [channel[,channel] [server]] -@* -list channels and their topic@* -@* -channel: channel to list@* -server: server name@* -@* -@item lusers [mask [target]] -@* -get statistics about the size of the IRC network@* -@* -mask: servers matching the mask only@* -target: server for forwarding request@* -@* -@item me message -@* -send a CTCP action to the current channel@* -@* -message: message to send@* -@* -@item mode @{ channel @{[+|-]|o|p|s|i|t|n|b|v@} [limit] [user] [ban mask] @} | @{ nickname @{[+|-]|i|w|s|o@} @} -@* -change channel or user mode@* -@* -channel modes:@* - channel: channel name to modify@* - o: give/take channel operator privileges@* - p: private channel flag@* - s: secret channel flag@* - i: invite-only channel flag@* - t: topic settable by channel operator only flag@* - n: no messages to channel from clients on the outside@* - m: moderated channel@* - l: set the user limit to channel@* - b: set a ban mask to keep users out@* - e: set exception mask@* - v: give/take the ability to speak on a moderated channel@* - k: set a channel key (password)@* -user modes:@* - nickname: nickname to modify@* - i: mark a user as invisible@* - s: mark a user for receive server notices@* - w: user receives wallops@* - o: operator flag@* -@* -@item motd [target] -@* -get the "Message Of The Day"@* -@* -target: server name@* -@* -@item msg receiver[,receiver] text -@* -send message to a nick or channel@* -@* -receiver: nick or channel (may be mask, '*' = current channel)@* -text: text to send@* -@* -@item names [channel[,channel]] -@* -list nicknames on channels@* -@* -channel: channel name@* -@* -@item nick [-all] nickname -@* -change current nickname@* -@* --all: set new nickname for all connected servers@* -nickname: new nickname@* -@* -@item notice nickname text -@* -send notice message to user@* -@* -nickname: user to send notice to@* -text: text to send@* -@* -@item op nickname [nickname] -@* -gives channel operator status to nickname(s)@* -@* -@item oper user password -@* -get operator privileges@* -@* -user/password: used to get privileges on current IRC server@* -@* -@item part [channel[,channel]] [part_message] -@* -leave a channel@* -@* -channel: channel name to leave@* -part_message: part message (displayed to other users)@* -@* -@item ping server1 [server2] -@* -ping server@* -@* -server1: server to ping@* -server2: forward ping to this server@* -@* -@item pong daemon [daemon2] -@* -answer to a ping message@* -@* -daemon: daemon who has responded to Ping message@* -daemon2: forward message to this daemon@* -@* -@item query nickname [text] -@* -send a private message to a nick@* -@* -nickname: nickname for private conversation@* -text: text to send@* -@* -@item quit [quit_message] -@* -close all connections & quit@* -@* -quit_message: quit message (displayed to other users)@* -@* -@item quote data -@* -send raw data to server without parsing@* -@* -data: raw data to send@* -@* -@item rehash -@* -tell the server to reload its config file@* -@* -@item restart -@* -tell the server to restart itself@* -@* -@item service nickname reserved distribution type reserved info -@* -register a new service@* -@* -distribution: visibility of service@* -type: reserved for future usage@* -@* -@item servlist [mask [type]] -@* -list services currently connected to the network@* -@* -mask: list only services matching this mask@* -type: list only services of this type@* -@* -@item squery service text -@* -deliver a message to a service@* -@* -service: name of service@* -text: text to send@* -@* -@item squit server comment -@* -disconnect server links@* -@* -server: server name@* -comment: comment for quit@* -@* -@item stats [query [server]] -@* -query statistics about server@* -@* -query: c/h/i/k/l/m/o/y/u (see RFC1459)@* -server: server name@* -@* -@item summon user [target [channel]] -@* -give users who are on a host running an IRC server a message asking them to please join IRC@* -@* -user: username@* -target: server name@* -channel: channel name@* -@* -@item time [target] -@* -query local time from server@* -@* -target: query time from specified server@* -@* -@item topic [channel] [topic] -@* -get/set channel topic@* -@* -channel: channel name@* -topic: new topic for channel (if topic is "-delete" then topic is deleted)@* -@* -@item trace [target] -@* -find the route to specific server@* -@* -target: server@* -@* -@item unban [channel] nickname [nickname ...] -@* -unbans nicks or hosts@* -@* -channel: channel for unban@* -nickname: user or host to unban@* -@* -@item userhost nickname [nickname ...] -@* -return a list of information about nicknames@* -@* -nickname: nickname@* -@* -@item users [target] -@* -list of users logged into the server@* -@* -target: server@* -@* -@item version [server | nickname] -@* -gives the version info of nick or server (current or specified)@* -@* -server: server name@* -nickname: nickname@* -@* -@item voice [nickname [nickname]] -@* -gives voice to nickname(s)@* -@* -@item wallops text -@* -send a message to all currently connected users who have set the 'w' user mode for themselves@* -@* -text to send@* -@* -@item who [mask ["o"]] -@* -generate a query which returns a list of information@* -@* -mask: only information which match this mask@* -o: only operators are returned according to the mask supplied@* -@* -@item whois [server] nickname[,nickname] -@* -query information about user(s)@* -@* -server: server name@* -nickname: nickname (may be a mask)@* -@* -@item whowas nickname [,nickname [,nickname ...]] [count [target]] -@* -ask for information about a nickname which no longer exists@* -@* -nickname: nickname to search@* -count: number of replies to return (full search if negative number)@* -target: reply should match this mask@* -@* -@end table - -Internal functions for keys:@* - -@table @kbd -@item return -terminate line@* -@item tab -complete word@* -@item backspace -delete previous char@* -@item delete -delete next char@* -@item delete_end_line -delete until end of line@* -@item delete_beginning_line -delete until beginning of line@* -@item delete_line -delete entire line@* -@item delete_previous_word -delete previous word@* -@item delete_next_word -delete next word@* -@item clipboard_paste -paste current clipboard content@* -@item transpose_chars -transpose chars@* -@item home -go to beginning of line@* -@item end -go to end of line@* -@item left -move one char left@* -@item previous_word -move to previous word@* -@item right -move one char right@* -@item next_word -move to next word@* -@item up -call previous command in history@* -@item up_global -call previous command in global history@* -@item down -call next command in history@* -@item down_global -call next command in global history@* -@item page_up -scroll one page up@* -@item page_down -scroll one page down@* -@item nick_beginning -display beginning of nicklist@* -@item nick_end -display end of nicklist@* -@item nick_page_up -scroll nicklist one page up@* -@item nick_page_down -scroll nicklist one page down@* -@item jump_smart -jump to buffer with activity@* -@item jump_dcc -jump to DCC buffer@* -@item jump_last_buffer -jump to last buffer@* -@item jump_server -jump to server buffer@* -@item jump_next_server -jump to next server@* -@item switch_server -switch active server on servers buffer@* -@item scroll_previous_highlight -scroll to previous highlight in buffer@* -@item scroll_next_highlight -scroll to next highlight in buffer@* -@item scroll_unread -scroll to first unread line in buffer@* -@item hotlist_clear -clear hotlist@* -@item infobar_clear -clear infobar@* -@item refresh -refresh screen@* -@item grab_key -grab a key@* -@end table - -@node FIFO pipe, , Comandos do WeeChat, Utilizacao -@section FIFO pipe - -You can remote control WeeChat, by sending commands or text to a FIFO pipe -(you have to enable option "irc_fifo_pipe", it is disabled by default).@* -The FIFO pipe is located in ~/.weechat/ and is called "weechat_fifo_xxxxx" -(where xxxxx is the process ID (PID) of running WeeChat).@* -So if many WeeChat are running, you have many FIFO pipe, one for each session.@* -@* -The syntax for the FIFO pipe commands/text is:@* -@command{server,channel *text or command here}@* -where server and channel are optional, but if channel is here, server should be too.@* -@* -Some examples: -@table @asis -@item @bullet{} change your nick on freenode to "mynick|out": -@* -@command{echo "freenode */nick mynick|out" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on #weechat channel: -@* -@command{echo "freenode,#weechat *hello everybody!" >~/.weechat/weechat_fifo_12345} -@* -@item @bullet{} display text on current channel (buffer displayed by WeeChat): -@* -@command{echo "*hello!" >~/.weechat/weechat_fifo_12345} -@* -@b{Warning:} this is dangerous and you should not do that except if you know what you do! -@* -@item @bullet{} send 2 commands to unload/reload Perl scripts (you have to separate them with \n): -@* -@command{echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345} -@end table -@* -You can write a script to send command to all running WeeChat at same time, for example:@* -@verbatim - #!/bin/sh - if [ $# -eq 1 ]; then - for fifo in $(/bin/ls ~/.weechat/weechat_fifo_* 2>/dev/null); do - echo -e "$1" >$fifo - done - fi -@end verbatim -@* -If the script is called "auto_weechat_command", you can run it with:@* -@command{./auto_weechat_command "freenode,#weechat *hello"} - - -@c ********************************* Plugins ********************************** - -@node Plugins, Autores/Suporte, Utilizacao, Top -@chapter Plugins - -@menu -* Plugins in WeeChat:: -* Write a plugin:: -* Plugin example:: -* Scripts plugins:: -@end menu - -@node Plugins in WeeChat, Write a plugin, Plugins, Plugins -@section Plugins in WeeChat - -A plugin is a C program which can call WeeChat functions defined in an -interface.@* -@* -This C program does not need WeeChat sources to compile and can be -dynamically loaded into WeeChat with command @command{/plugin}.@* -@* -The plugin has to be a dynamic library, for dynamic loading by -operating system. -Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under -Windows. - -@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins -@section Write a plugin - -@subsection Base rules - -The plugin should include ``weechat-plugin.h'' file (available in -WeeChat source code).@* -This file defines structures and types used to communicate with WeeChat.@* -@* -The plugin must have some variables and functions (mandatory, without -them the plugin can't load):@* -@itemize @bullet -@item variables for plugin description: -@itemize @minus -@item plugin_name[]: plugin name -@item plugin_version[]: plugin version -@item plugin_description[]: short description of plugin -@end itemize -@item functions for init and end of plugin: -@itemize @minus -@item weechat_plugin_init: function called when plugin is loaded, -must return PLUGIN_RC_OK (0) if successful, PLUGIN_RC_KO (-1) if error -@item weechat_plugin_end: function called when plugin is unloaded -@end itemize -@end itemize - -@subsection API functions - -The plugin can call some functions defined in t_weechat_plugin -structure.@* -@* -These functions are detailed below:@* - -@itemize @bullet -@item -@command{int ascii_strcasecmp (t_weechat_plugin *plugin, -char *string1, char *string2)}@* -@* -Locale and case independent string comparison.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* -@* - -@item -@command{int ascii_strncasecmp (t_weechat_plugin *plugin, -char *string1, char *string2, int max)}@* -@* -Locale and case independent string comparison, for ``max'' chars.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string1}: first string for comparison -@item @option{string2}: second string for comparison -@item @option{max}: max number of chars for comparison -@end itemize -@* -@emph{Return value:}@* -@* -Difference between two strings: negative if chaine1 < chaine2, -nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* -@* -@emph{Example:}@* -@* -@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* -@* - -@item -@command{char **explode_string (t_weechat_plugin *plugin, -char *string, char *separators, int num_items_max, int *num_items)}@* -@* -Explode a string according to one or more delimiter(s).@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string to explode -@item @option{separators}: delimiters used for explosion -@item @option{num_items_max}: maximum number of items created (0 means -no limit) -@item @option{num_items}: pointer to int which will contain number of -items created -@end itemize -@* -@emph{Return value:}@* -@* -Array of strings, NULL if problem.@* -Note: the result has to be free by a call to ``free_exploded_string'' -function after use.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{char **free_exploded_string (t_weechat_plugin *plugin, -char **string)}@* -@* -Free memory used by a string explosion.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{string}: string exploded by ``explode_string'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{char *argv;}@* -@code{int argc;}@* -@code{argv = plugin->explode_string (plugin, string, " ", 0, &argc);}@* -@code{...}@* -@code{if (argv != NULL)}@* -@code{plugin->free_exploded_string (plugin, argv);}@* -@* - -@item -@command{void exec_on_files (t_weechat_plugin *plugin, char *directory, -int (*callback)(t_weechat_plugin *, char *))}@* -@* -Execute a function on all files of a directory.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{directory}: directory for searching files -@item @option{callback}: function called for each file found -@end itemize -@* -@emph{Return value:}@* -@* -Aucune.@* -@* -@emph{Exemple :}@* -@* -@code{int callback (t_weechat_plugin *plugin, char *file)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "file: %s", file);}@* -@code{@ @ @ @ return 1;}@* -@code{@}}@* -@code{}@* -@code{...}@* -@code{plugin->exec_on_files (plugin, "/tmp", &callback);}@* -@* - -@item -@command{void printf (t_weechat_plugin *plugin, -char *server, char *channel, char *message, ...)}@* -@* -Display a message on a WeeChat buffer, identified by server and -channel (both may be NULL for current buffer).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server to find buffer for message -display (may be NULL) -@item @option{channel}: name of channel to find buffer for message -display (may be NULL) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->printf (NULL, NULL, "hello");}@* -@code{plugin->printf (NULL, "#weechat", "hello");}@* -@code{plugin->printf ("freenode", "#weechat", "hello");}@* -@* - -@item -@command{void printf_server (t_weechat_plugin *plugin, -char *message, ...)}@* -@* -Display a message on server buffer.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_server ("hello");}@* -@* - -@item -@command{void printf_infobar (t_weechat_plugin *plugin, -int time, char *message, ...)}@* -@* -Display a message in infobar for a specified time.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{time}: time in seconds for displaying message (0 means -never erased) -@item @option{message}: message -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->printf_infobar (5, "hello");}@* -@* - -@item -@command{t_plugin_handler *msg_handler_add (t_weechat_plugin -*plugin, char *message, t_plugin_handler_func *handler_func, -char *handler_args, void *handler_pointer)}@* -@* -Add an IRC message handler, called when an IRC message is received.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{message}: IRC message (for example: ``PRIVMSG'') -@item @option{handler_func}: function called when message is received -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new message handler.@* -@* -@emph{Example:}@* -@* -@code{int msg_kick (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "KICK received");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent to -WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent to -other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin -*plugin, char *command, char *description, char *arguments, -char *arguments_description, char *completion_template, -t_plugin_handler_func *handler_func, char *handler_args, -void *handler_pointer)}@* -@* -Add a WeeChat command handler, called when user uses command -(for example /command).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{command}: the new command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers name -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@item @option{handler_func}: function called when comand is executed -@item @option{handler_args}: arguments given to function when called -@item @option{handler_pointer}: pointer given to function when called -@end itemize -@* -@emph{Return value:}@* -@* -Pointer to new command handler.@* -@* -@emph{Example:}@* -@* -@code{int cmd_test (t_weechat_plugin *plugin, char *server, -char *command, char *arguments, char *handler_args, -void *handler_pointer)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf (plugin, server, NULL, "test command, -file: %s", (arguments) ? arguments : "none");}@* -@code{@ @ @ @ return PLUGIN_RC_OK;}@* -@code{@}}@* -@code{...}@* -@code{plugin->cmd_handler_add (plugin, "test", "Test command", -"[file]", "file: a file name", &cmd_test, NULL, NULL);}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -@command{void handler_remove (t_weechat_plugin *plugin, -t_plugin_handler *handler)}@* -@* -Remove a command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{handler}: handler to remove -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->handler_remove (plugin, my_handler);}@* -@* - -@item -@command{void handler_remove_all (t_weechat_plugin *plugin)}@* -@* -Remove all handlers for a plugin.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example :}@* -@* -@code{plugin->handler_remove_all (plugin);}@* -@* - -@item -@command{void exec_command (t_weechat_plugin -*plugin, char *server, char *channel, char *command)}@* -@* -Execute a WeeChat command (or send a message to a channel).@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{server}: name of server for executing command (may be -NULL) -@item @option{channel}: name of channel for executing command (may be -NULL) -@item @option{command}: command -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Examples:}@* -@* -@code{plugin->exec_command (plugin, NULL, NULL, "/help nick");}@* -@code{plugin->exec_command (plugin, "freenode", "#weechat", "hello");}@* -@* - -@item -@command{char *get_info (t_weechat_plugin -*plugin, char *info, char *server)}@* -@* -Return an info about WeeChat or a channel.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{info}: name of info to read: -@itemize @minus -@item @option{version}: get WeeChat's version -@item @option{nick}: get nick -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir -@end itemize -@item @option{server}: name of server for reading info (if needed) -@end itemize -@* -@emph{Return value:}@* -@* -Information asked, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *version = plugin->get_info (plugin, "version", NULL);}@* -@code{char *nick = plugin->get_info (plugin, "nick", "freenode");}@* -@* - -@item -@command{t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)}@* -@* -Returns list of DCC currently active or finished.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@end itemize -@* -@emph{Return value:}@* -@* -Chained list of DCC.@* -Note: result has to be free by a call to ``free_dcc_info'' function -after use.@* -@* -@emph{Example:}@* -@* -@code{t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin);}@* -@code{for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = -ptr_dcc->next_dcc)}@* -@code{@{}@* -@code{@ @ @ @ plugin->printf_server (plugin, "DCC type=%d, with: %s", -ptr_dcc->type, ptr_dcc->nick);}@* -@code{@}}@* -@* - -@item -@command{void free_dcc_info (t_weechat_plugin *plugin, -t_plugin_dcc_info *dcc_info)}@* -@* -Free memory used by a DCC list.@* - -@emph{Param@`etres :} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{dcc_info}: pointer to DCC list returned by -``get_dcc_info'' function -@end itemize -@* -@emph{Return value:}@* -@* -None.@* -@* -@emph{Example:}@* -@* -@code{plugin->free_dcc_info (plugin, dcc_info);}@* -@* - -@item -@command{char *get_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Examples:}@* -@* -@code{char *value1 = plugin->get_config (plugin, "look_nicklist");}@* -@code{char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");}@* -@* - -@item -@command{int set_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a WeeChat config option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_config (plugin, "look_nicklist", "off");}@* -@* - -@item -@command{char *get_plugin_config (t_weechat_plugin -*plugin, char *option)}@* -@* -Return value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to read -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, NULL if not found.@* -Note: result has to be free by a call to ``free'' function after -use.@* -@* -@emph{Example:}@* -@* -@code{char *value = plugin->get_plugin_config (plugin, "my_var");}@* -@* - -@item -@command{int set_plugin_config (t_weechat_plugin -*plugin, char *option, char *value)}@* -@* -Update value of a plugin option.@* - -@emph{Arguments:} -@itemize @minus -@item @option{plugin}: pointer to plugin structure -@item @option{option}: name of option to update -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if option was updated successfully, 0 if error occured.@* -@* -@emph{Example:}@* -@* -@code{plugin->set_plugin_config (plugin, "my_var", "value");}@* -@* - -@end itemize - -@subsection Compile plugin - -Compile does not need WeeChat sources, only file -``weechat-plugin.h''.@* - -To compile a plugin which has one file ``toto.c'' (sous GNU/Linux):@* -@* -gcc -fPIC -Wall -c toto.c@* -gcc -shared -fPIC -o libtoto.so toto.o - -@subsection Load plugin under WeeChat - -Copy ``libtoto.so'' file into general plugins dir (for example -/usr/local/lib/weechat/plugins) or into user's plugins dir (for -example /home/xxxxx/.weechat/plugins).@* -@* -Under WeeChat:@* -@command{/plugin load toto} - -@node Plugin example, Scripts plugins, Write a plugin, Plugins -@section Plugin example - -Full example of plugin, which adds a /double command, which displays -two times arguments on current channel (ok that's not very useful, but -that's just an example!):@* - -@verbatim -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Toto"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/hello" command handler */ - -int toto_cmd_double (t_weechat_plugin *plugin, char *server, - char *command, char *arguments, - char *handler_args, void *handler_pointer) -{ - if (arguments && arguments[0] && (arguments[0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, arguments); - plugin->exec_command (plugin, NULL, NULL, arguments); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message", - NULL, - &toto_cmd_double, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -@end verbatim - -@node Scripts plugins, , Plugin example, Plugins -@section Scripts plugins - -Three plugins are provided with WeeChat to load scripts: Perl, -Python and Ruby. - -@subsection Load/unload scripts - -Perl scripts are loaded and unloaded with @command{/perl}, -@command{/python} and @command{/ruby} commands. -(type @kbd{/help} within WeeChat to get help about commands).@* - -@emph{Examples:}@* -@itemize @bullet -@item -Load a Perl script: @kbd{/perl load /tmp/sample.pl}@* -@item -Unload all Perl scripts: @kbd{/perl unload}@* -@item -List all Perl scripts: @kbd{/perl}@* -@item -Load a Python script: @kbd{/python load /tmp/sample.py}@* -@item -Unload all Python scripts: @kbd{/python unload}@* -@item -List all Python scripts: @kbd{/python}@* -@end itemize - -@subsection WeeChat / Scripts API - -@itemize @bullet -@item -Perl: @command{weechat::register ( name, version, shutdown_function, -description );}@* -Python: @command{weechat.register ( name, version, shutdown_function, -description )}@* -@* -This is first function to call in script.@* -All 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}: 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{Return value:}@* -@* -1 if script was registered, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::register ("sample", "1.0", "sample_end", "Sample -script!");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.register ("sample", "1.0", "sample_end", "Sample -script!")}@* -@* - -@item -Perl: @command{weechat::print ( message, [channel, [server]] );}@* -Python: @command{weechat.prnt ( message, [channel, [server]] )}@* -@* -Print message in a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{message}: message to display -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::print ("message");}@* -@code{weechat::print ("message", "#weechat");}@* -@code{weechat::print ("message", "#weechat", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.prnt ("message")}@* -@code{weechat.prnt ("message", "#weechat")}@* -@code{weechat.prnt ("message", "#weechat", "freenode")}@* -@* - -@item -Perl: @command{weechat::print_infobar ( delay, message );}@* -Python: @command{weechat.print_infobar ( delay, message )}@* -@* -Print message in infobar.@* - -@emph{Arguments:} -@itemize @minus -@item @option{delay}: after this delay (in seconds), message will be erased -(if 0, message will not be erased). -@item @option{message}: message to display -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::print_infobar (5, "message");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.print_infobar (5, "message")}@* -@* - -@item -Perl: @command{weechat::add_message_handler ( name, function );}@* -Python: @command{weechat.add_message_handler ( name, function )}@* -@* -Attach a script 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}: function called when message is received -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_message_handler ("privmsg", my_function);}@* -@code{sub my_function}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print ("server=$_[0]\n");}@* -@code{@ @ @ @ ($null, $channel, $message) = split ":",$_[1],3;}@* -@code{@ @ @ @ ($hostmask, $null, $channel) = split " ", $channel;}@* -@code{@ @ @ @ weechat::print ("host=$hostmask, chan=$channel, msg=$message\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_message_handler ("privmsg", my_function)}@* -@code{def my_function(server, args):}@* -@code{@ @ @ @ weechat.prnt("server="+server)}@* -@code{@ @ @ @ null, channel, message = string.split(args, ":", 2)}@* -@code{@ @ @ @ hostmask, null, channel = string.split(string.strip(channel), " ", 2)}@* -@code{@ @ @ @ weechat.prnt("host="+hostmask+", channel="+channel+", message="+message)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when message is received has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@item @option{PLUGIN_RC_OK_IGNORE_WEECHAT}: message will not be sent -to WeeChat -@item @option{PLUGIN_RC_OK_IGNORE_PLUGINS}: message will not be sent -to other plugins -@item @option{PLUGIN_RC_OK_IGNORE_ALL}: message will not be sent to -WeeChat neither other plugins -@end itemize -@* - -@item -Perl: @command{weechat::add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] );}@* -Python: @command{weechat.add_command_handler ( name, function, -[description, arguments, arguments_description, -completion_template] )}@* -@* -Create new WeeChat command, linked with script 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 -script function. Be careful when overriding WeeChat commands, they'll not be -available until your script will be unloaded. -@item @option{function}: function linked with command -@item @option{description}: command description (displayed by /help -command) -@item @option{arguments}: short description of command arguments -(displayed by /help command) -@item @option{arguments_description}: long description of command -arguments (displayed by /help command) -@item @option{completion_template}: template for completion, like -@code{abc|%w def|%i} which means ``abc'' or a WeeChat command -for first argument, and ``def'' or IRC command for second.@* -Following codes can be used: -@itemize @minus -@item @code{%-}: no completion for argument -@item @code{%a}: alias -@item @code{%A}: alias and commands (WeeChat, IRC and plugins) -@item @code{%c}: current channel -@item @code{%C}: channels of current server -@item @code{%f}: filename -@item @code{%h}: plugins commands -@item @code{%i}: IRC commands (sent) -@item @code{%I}: IRC commands (received) -@item @code{%k}: keys -@item @code{%n}: nicks of current channel -@item @code{%o}: setup option -@item @code{%p}: default ``part'' message -@item @code{%q}: default ``quit'' message -@item @code{%s}: current server name -@item @code{%S}: all servers names -@item @code{%t}: topic of current channel -@item @code{%v}: setup option value -@item @code{%w}: WeeChat commands -@item @code{%y}: default ``away'' message -@end itemize -@end itemize -@* -@emph{Return value:}@* -@* -1 if function was attached, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::add_command_handler ("command", my_command);}@* -@code{sub my_command}@* -@code{@{ }@* -@code{@ @ @ @ weechat::print("Server: $_[0], arguments: $_[1]\n");}@* -@code{@ @ @ @ return 0;}@* -@code{@} }@* -@* -@emph{Python example:}@* -@* -@code{weechat.add_command_handler ("command", my_command)}@* -@code{def my_command(server, args):}@* -@code{@ @ @ @ weechat.prnt("server:"+server+" arguments:"+args)}@* -@code{@ @ @ @ return 0}@* -@* -@emph{Notes:}@* -@* -Function called when command is executed has to return one of these -values (prefixed by ``weechat::'' for Perl and ``weechat.'' for -Python):@* -@itemize @minus -@item @option{PLUGIN_RC_KO}: function failed -@item @option{PLUGIN_RC_OK}: function successfully completed -@end itemize -@* - -@item -Perl: @command{weechat::remove_handler ( name, function );}@* -Python: @command{weechat.remove_handler ( name, function )}@* -@* -Remove a message or command handler.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of IRC message or command handler -@item @option{function}: function -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::remove_handler ("command", my_command);}@* -@* -@emph{Python example:}@* -@* -@code{weechat.remove_handler ("command", my_command)}@* -@* - -@item -Perl: @command{weechat::command ( command, [channel, [server]] );}@* -Python: @command{weechat.command ( command, [channel, [server]] )}@* -@* -Execute a command or send a message to a channel.@* - -@emph{Arguments:} -@itemize @minus -@item @option{command}: command to execute (or message to send in a channel) -@item @option{channel}: name of channel -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::command ("hello world!");}@* -@code{weechat::command ("/kick toto please leave this chan", "#weechat");}@* -@code{weechat::command ("/nick newnick", "", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.command ("hello world!")}@* -@code{weechat.command ("/kick toto please leave this chan", "#weechat")}@* -@code{weechat.command ("/nick newnick", "", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_info ( name, [server] );}@* -Python: @command{weechat.get_info ( name, [server] )}@* -@* -Get various info about WeeChat, server or user.@* - -@emph{Arguments:} -@itemize @minus -@item @option{name}: name of info to retrieve: -@itemize @minus -@item @option{version}: get WeeChat version -@item @option{nick}: get nickname -@item @option{channel}: get channel name -@item @option{server}: get server name -@item @option{away}: get ``away'' flag -@item @option{weechat_dir}: get WeeChat home dir -@item @option{weechat_libdir}: get WeeChat system lib dir -@item @option{weechat_sharedir}: get WeeChat system share dir - -@end itemize -@item @option{server}: internal name of server -@end itemize -@* -@emph{Return value:}@* -@* -Asked info, empty if error occured or info was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$version = weechat::get_info("version");}@* -@code{$nick = weechat::get_info("nick", "freenode");}@* -@* -@emph{Python examples:}@* -@* -@code{$version = weechat.get_info("version")}@* -@code{$nick = weechat.get_info("nick", "freenode")}@* -@* - -@item -Perl: @command{weechat::get_dcc_info ( );}@* -Python: @command{weechat.get_dcc_info ( );}@* -@* -Get DCC list.@* - -Returned array has following fields: -@itemize @minus -@item server: IRC server -@item channel: IRC channel -@item type: DCC type: -@itemize @minus -@item 0: chat (received) -@item 1: chat (sent) -@item 2: file (receiving) -@item 3: file (sending) -@end itemize -@item status: DCC status: -@itemize @minus -@item 0: waiting -@item 1: connecting -@item 2: active -@item 3: done -@item 4: failed -@item 5: aborted -@end itemize -@item start_time: date/time of DCC creation -@item start_transfer: date/time of transfer start -@item addr: remote address -@item port: port used for DCC -@item nick: remote nick -@item filename: filename -@item local_filename: local filename -@item size: file size -@item pos: current position in file -@item start_resume: restart position after interruption -@item bytes_per_sec: bytes sent/received per second -@end itemize -@* -@emph{Return value:}@* -@* -DCC list, 0 if error occured.@* -@* - -@item -Perl: @command{weechat::get_config ( option );}@* -Python: @command{weechat.get_config ( option )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl examples:}@* -@* -@code{$value1 = weechat::get_config ("look_nicklist");}@* -@code{$value2 = weechat::get_config ("freenode.server_autojoin");}@* -@* -@emph{Python examples:}@* -@* -@code{$value1 = weechat.get_config ("look_nicklist")}@* -@code{$value2 = weechat.get_config ("freenode.server_autojoin")}@* -@* - -@item -Perl: @command{weechat::set_config ( option, value );}@* -Python: @command{weechat.set_config ( option, value )}@* -@* -Get WeeChat config option value.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl examples:}@* -@* -@code{weechat::set_config ("look_nicklist", "off");}@* -@code{weechat::set_config ("freenode.server_autojoin"", -"#weechat");}@* -@* -@emph{Python examples:}@* -@* -@code{weechat.set_config ("look_nicklist", "off")}@* -@code{weechat.set_config ("freenode.server_autojoin"", "#weechat")}@* -@* - -@item -Perl: @command{weechat::get_plugin_config ( option );}@* -Python: @command{weechat.get_plugin_config ( option )}@* -@* -Return value of a plugin option.@* -Option is read from file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@end itemize -@* -@emph{Return value:}@* -@* -Value of option, empty if error occured or option was not found.@* -@* -@emph{Perl example:}@* -@* -@code{$value = weechat::get_plugin_config ("my_var");}@* -@* -@emph{Python example:}@* -@* -@code{$value = weechat.get_plugin_config ("my_var")}@* -@* - -@item -Perl: @command{weechat::set_plugin_config ( option, value );}@* -Python: @command{weechat.set_plugin_config ( option, value )}@* -@* -Update value of a plugin option.@* -Option is written in file ~/.weechat/plugins.rc and is like:@* -@code{plugin.script.option=value}@* -Note: plugin and script names are automatically added.@* - -@emph{Arguments:} -@itemize @minus -@item @option{option}: name of option -@item @option{value}: new value for option -@end itemize -@* -@emph{Return value:}@* -@* -1 if successful, 0 if error occured.@* -@* -@emph{Perl example:}@* -@* -@code{weechat::set_plugin_config ("my_var", "value");}@* -@* -@emph{Python example:}@* -@* -@code{weechat.set_plugin_config ("my_var", "value")}@* -@* - -@end itemize - - -@c **************************** Autores/Suporte ***************************** - -@node Autores/Suporte, , Plugins, 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}> - -@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 : @uref{http://forums.flashtux.org}@*@* -@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{} 2005 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 - |