$ mkdir build $ cd build $ cmake .. $ make % make install (as root)
This manual documents WeeChat chat client, it is part of WeeChat.
Latest version of this document can be found on this page: http://www.weechat.org/doc
WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and light, designed for many operating systems.
Main features are:
multi-protocols (IRC and other soon)
multi-servers connection (with SSL, IPv6, proxy)
many GUI: Curses (wxWidgets, Gtk and Qt under development)
small, fast and light
customizable and extensible with plugins and scripts
multi-platform (GNU/Linux, *BSD, MacOS X, Windows and other)
100% GPL, free software
WeeChat homepage is here: http://www.weechat.org/
In order to install WeeChat, you need:
a running GNU/Linux system (with compiler tools for source package), or compatible OS
root privileges (to install WeeChat in a system directory)
ncurses library
Binary packages are available for many distributions, including:
Debian (or any Debian compatible distribution): apt-get install weechat
Mandriva/RedHat (or any RPM compatible distribution): rpm -i /path/to/weechat-x.y.z-1.i386.rpm
Gentoo: emerge weechat
Some additional packages may be useful, like weechat-plugins.
For other distributions, please look at your manual for installation instructions.
WeeChat can be compiled with cmake or autotools (cmake is recommended way).
Installation in system directories (requires root privileges):
$ mkdir build $ cd build $ cmake .. $ make % make install (as root)
Installation in custom directory:
$ mkdir build $ cd build $ cmake .. -DPREFIX=/path/to/directory $ make $ make install
Installation in system directories (requires root privileges):
$ ./configure $ make % make install (as root)
Installation in custom directory:
$ ./configure --prefix=/path/to/directory $ make $ make install
Warning: GIT sources are for advanced users: it may not compile or not be stable. You’re warned!
To get GIT sources, issue this command:
$ git clone git://git.sv.gnu.org/weechat.git
If you’re using autotools (and not cmake), execute this script:
$ ./autogen.sh
Then follow instructions for source package (see [source_package]).
Command line arguments:
Disable auto-connect to servers when WeeChat is starting
Set path as home for WeeChat (used for configuration files, logs, user plugins and scripts), default value is ~/.weechat (note: directory is created if not found by WeeChat)
Display help
Display WeeChat default keys
Display WeeChat license
Disable plugins auto-load
Display WeeChat version
Option for plugin (see doc for each plugin)
To start WeeChat, issue this command:
$ weechat-curses
When you run WeeChat for the first time, a default configuration file is created, with default options. The default configuration file is: ~/.weechat/weechat.conf.
You can edit this file at your convenience to configure WeeChat or you can set parameters with /set command in WeeChat (see [weechat_commands]).
Example of terminal with WeeChat:
┌─────────────────────────────────────────────────────────────────────────────────────────┐ │Welcome to #test, this is a test channel │ │12:52:27 --> | flashy (n=flashcod@hellix.flashtux.org) has joined #test │@ChanServ │ │12:52:27 -- | Nicks #test: [@ChanServ @flashy +_FlashB0t joe mike] │@flashy │ │12:52:27 -- | Channel #test: 5 nicks (2 ops, 0 halfop, 1 voice, 2 normal) │+_FlashB0t│ │12:52:27 -- | Channel created on Tue Jan 27 06:30:17 2009 │joe │ │12:54:15 flashy | hey! │mike │ │12:55:01 joe | hi flashy! │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [4] [irc/freenode] 3:#test(+n){5}* [Act: 4,2] │ │[flashy] hi joe!█ │ └─────────────────────────────────────────────────────────────────────────────────────────┘
Screen is composed by following areas:
chat area (middle of screen) with chat lines, and for each line:
time
prefix (before "|")
message (after "|")
bars around chat area, default bars are:
title bar, above chat area
status bar, below chat area
input bar, below status bar
nicklist bar, on the right
Bar status has following default items:
Item | Example | Description |
---|---|---|
time |
[12:55] |
time |
buffer_count |
[4] |
number of opened buffers |
buffer_plugin |
[irc/freenode] |
plugin of current buffer (irc plugin can add IRC server name used by buffer) |
buffer_number |
3 |
current buffer number |
buffer_name |
#test(+n) |
current buffer name |
buffer_nicklist_count |
{5} |
number of nicks in nicklist |
buffer_filter |
* |
filtering indicator: * means some lines are filtered (hidden), empty value means all lines are displayed |
lag |
[Lag: 2.5] |
lag indicator, in seconds (hidden if lag is low) |
hotlist |
[Act: 4,2] |
list of buffers with activity (unread messages) |
completion |
abc(2) def(5) |
list of words for completion, with number of possible completions for each word |
scroll |
-MORE(50)- |
scroll indicator, with number of lines below last line displayed |
Bar input has following default items:
Item | Example | Description |
---|---|---|
input_paste |
[Paste 7 lines ? [ctrl-Y] Yes [ctrl-N] No] |
question to user for pasting lines |
input_prompt |
[nick] |
input prompt (nick for irc plugin) |
away |
(away) |
away indicator |
input_search |
[Text search] |
text search indicator |
input_text |
bla bla… |
input text |
Keys | Description and command |
---|---|
Left arrow |
Go to previous char in command line |
Right arrow |
Go to next char in command line |
Ctrl + left arrow |
Go to previous word in command line |
Ctrl + right arrow |
Go to next word in command line |
Home |
Go to the beginning of command line |
End |
Go to the end of command line |
Ctrl + C then B |
Insert code for bold text |
Ctrl + C then C |
Insert code for colored text |
Ctrl + C then I |
Insert code for italic text |
Ctrl + C then O |
Insert code for color reset |
Ctrl + C then R |
Insert code for reverse color |
Ctrl + C then U |
Insert code for underlined text |
Delete |
Delete next char in command line |
Backspace |
Delete previous char in command line |
Ctrl + K |
Delete from cursor until end of command line (deleted string is copied to
clipboard) |
Ctrl + R |
Search for text in buffer history (two times: search exact text) |
Ctrl + T |
Transpose chars |
Ctrl + U |
Delete from cursor until beginning of command line (deleted string is copied
to clipboard) |
Ctrl + W |
Delete previous word of command line (deleted string is copied to clipboard) |
Ctrl + Y |
Paste clipboard content |
Tab |
Complete command or nick (Tab again: find next completion) |
Shift + Tab |
Without completion: do a partial completion, with pending completion:
complete with previous completion |
Any char |
Insert char at cursor position in command line |
Enter |
Execute command or send message (in search mode: stop search) |
Up arrow |
Call previous command/message (in search mode: search up) |
Down arrow |
Call next command/message (in search mode: search down) |
Ctrl + up arrow |
Call previous command/message in global history (common for all buffers) |
Ctrl + down arrow |
Call next command/message in global history (common for all buffers) |
Alt + D |
Delete next word in command line (deleted string is copied to clipboard) |
Alt + K |
Grab a key and insert its code (and command bound if key exists) in command
line |
Alt + R |
Delete entire command line |
Keys | Description and command |
---|---|
Ctrl + L |
Redraw whole window |
Ctrl + S then Ctrl + U |
Set unread marker on all buffers |
Ctrl + X |
Switch current buffer if buffers are attached with same number |
Page up |
Scroll up one page in buffer history |
Page down |
Scroll down one page in buffer history |
Alt + Page up |
Scroll up a few lines in buffer history |
Alt + Page down |
Scroll down a few lines in buffer history |
Alt + Home |
Scroll to top of buffer |
Alt + End |
Scroll to bottom of buffer |
Alt + left arrow |
Switch to previous buffer |
Alt + right arrow |
Switch to next buffer |
F7 |
Switch to previous window |
F8 |
Switch to next window |
F9 |
Scroll buffer’s title on the left |
F10 |
Scroll buffer’s title on the right |
F11 |
Scroll up one page in nicklist |
F12 |
Scroll down one page in nicklist |
Alt + F11 |
Go to the beginning of nicklist |
Alt + F12 |
Go to the end of nicklist |
Alt + A |
Switch to next buffer with activity (with priority: highlight, message,
other) |
Alt + J then Alt + L |
Switch to last buffer |
Alt + J then Alt + R |
Switch to IRC raw buffer |
Alt + J then Alt + S |
Switch to IRC server buffer |
Alt + digit (0-9) |
Switch to buffer by number (0 = 10) |
Alt + J then number (01-99) |
Switch to buffer by number |
Alt + N |
Scroll to next highlight |
Alt + P |
Scroll to previous highlight |
Alt + U |
Scroll to first unread line in buffer |
Alt + W then Alt + arrow |
Switch to window with direction |
Alt + Z |
Zoom on current window (Alt + Z again: restore initial windows state, before
zoom) |
Alt + < |
Switch to previous buffer in list of visited buffers |
Alt + > |
Switch to next buffer in list of visited buffers |
Keys | Description and command |
---|---|
Alt + H |
Clear hotlist (activity notification on other buffers) |
Alt + = |
Toggle filters on/off |
WeeChat command line (at the bottom of window) lets you execute commands or send text to buffer.
Commands begin with "/" char, followed by name of command. For example, to see list of all options:
/set
Text sent to a buffer is any text that does not begin with "/" char. For example, to send text hello on current buffer:
hello
However, it is possible to start with "/" char, by adding another. For example, to send text /set on current buffer:
//set
For some plugins like IRC, you can use color codes and attributes, as follow (press Ctrl-C then following letter, with optional value):
bold text
text color xx (see list of colors below)
text color xx and background yy (see list of colors below)
disable color and attributes
reverse video (revert text color with background)
underlined text
Note
|
The same code (without number for ^Cc) may be used to stop the attribute. |
Color codes for ^Cc are:
00 |
white |
01 |
black |
02 |
dark blue |
03 |
dark green |
04 |
light red |
05 |
dark red |
06 |
magenta |
07 |
orange |
08 |
yellow |
09 |
light green |
10 |
cyan |
11 |
light cyan |
12 |
light blue |
13 |
light magenta |
14 |
gray |
15 |
light gray (white) |
Example: display of "hello everybody!" with "hello" in light blue bold and "everybody" in light red underlined:
^Cc12^Cbhello^Cb^Cc04^Cu everybody^Cu^Cc!
weechat.color.bar_more
description: text color for + when scrolling bars
type: color
values: a color name (default value: lightmagenta)
weechat.color.chat
description: text color for chat
type: color
values: a color name (default value: default)
weechat.color.chat_bg
description: background color for chat
type: color
values: a color name (default value: default)
weechat.color.chat_buffer
description: text color for buffer names
type: color
values: a color name (default value: white)
weechat.color.chat_channel
description: text color for channel names
type: color
values: a color name (default value: white)
weechat.color.chat_delimiters
description: text color for delimiters
type: color
values: a color name (default value: green)
weechat.color.chat_highlight
description: text color for highlighted prefix
type: color
values: a color name (default value: yellow)
weechat.color.chat_highlight_bg
description: background color for highlighted prefix
type: color
values: a color name (default value: magenta)
weechat.color.chat_host
description: text color for hostnames
type: color
values: a color name (default value: cyan)
weechat.color.chat_nick
description: text color for nicks in chat window
type: color
values: a color name (default value: lightcyan)
weechat.color.chat_nick_color01
description: text color #1 for nick
type: color
values: a color name (default value: cyan)
weechat.color.chat_nick_color02
description: text color #2 for nick
type: color
values: a color name (default value: magenta)
weechat.color.chat_nick_color03
description: text color #3 for nick
type: color
values: a color name (default value: green)
weechat.color.chat_nick_color04
description: text color #4 for nick
type: color
values: a color name (default value: brown)
weechat.color.chat_nick_color05
description: text color #5 for nick
type: color
values: a color name (default value: lightblue)
weechat.color.chat_nick_color06
description: text color #6 for nick
type: color
values: a color name (default value: default)
weechat.color.chat_nick_color07
description: text color #7 for nick
type: color
values: a color name (default value: lightcyan)
weechat.color.chat_nick_color08
description: text color #8 for nick
type: color
values: a color name (default value: lightmagenta)
weechat.color.chat_nick_color09
description: text color #9 for nick
type: color
values: a color name (default value: lightgreen)
weechat.color.chat_nick_color10
description: text color #10 for nick
type: color
values: a color name (default value: blue)
weechat.color.chat_nick_other
description: text color for other nick in private buffer
type: color
values: a color name (default value: cyan)
weechat.color.chat_nick_self
description: text color for local nick in chat window
type: color
values: a color name (default value: white)
weechat.color.chat_prefix_action
description: text color for action prefix
type: color
values: a color name (default value: white)
weechat.color.chat_prefix_buffer
description: text color for buffer name (before prefix, when many buffers are merged with same number)
type: color
values: a color name (default value: brown)
weechat.color.chat_prefix_error
description: text color for error prefix
type: color
values: a color name (default value: yellow)
weechat.color.chat_prefix_join
description: text color for join prefix
type: color
values: a color name (default value: lightgreen)
weechat.color.chat_prefix_more
description: text color for + when prefix is too long
type: color
values: a color name (default value: lightmagenta)
weechat.color.chat_prefix_network
description: text color for network prefix
type: color
values: a color name (default value: magenta)
weechat.color.chat_prefix_quit
description: text color for quit prefix
type: color
values: a color name (default value: lightred)
weechat.color.chat_prefix_suffix
description: text color for suffix (after prefix)
type: color
values: a color name (default value: green)
weechat.color.chat_read_marker
description: text color for unread data marker
type: color
values: a color name (default value: magenta)
weechat.color.chat_read_marker_bg
description: background color for unread data marker
type: color
values: a color name (default value: default)
weechat.color.chat_server
description: text color for server names
type: color
values: a color name (default value: brown)
weechat.color.chat_text_found
description: text color for marker on lines where text sought is found
type: color
values: a color name (default value: yellow)
weechat.color.chat_text_found_bg
description: background color for marker on lines where text sought is found
type: color
values: a color name (default value: lightmagenta)
weechat.color.chat_time
description: text color for time in chat window
type: color
values: a color name (default value: default)
weechat.color.chat_time_delimiters
description: text color for time delimiters
type: color
values: a color name (default value: brown)
weechat.color.chat_value
description: text color for values
type: color
values: a color name (default value: cyan)
weechat.color.input_actions
description: text color for actions in input line
type: color
values: a color name (default value: lightgreen)
weechat.color.input_text_not_found
description: text color for unsucessful text search in input line
type: color
values: a color name (default value: red)
weechat.color.nicklist_away
description: text color for away nicknames
type: color
values: a color name (default value: cyan)
weechat.color.nicklist_group
description: text color for groups in nicklist
type: color
values: a color name (default value: green)
weechat.color.nicklist_more
description: text color for + when scrolling nicks in nicklist
type: color
values: a color name (default value: lightmagenta)
weechat.color.nicklist_prefix1
description: text color for prefix #1 in nicklist
type: color
values: a color name (default value: lightgreen)
weechat.color.nicklist_prefix2
description: text color for prefix #2 in nicklist
type: color
values: a color name (default value: lightmagenta)
weechat.color.nicklist_prefix3
description: text color for prefix #3 in nicklist
type: color
values: a color name (default value: yellow)
weechat.color.nicklist_prefix4
description: text color for prefix #4 in nicklist
type: color
values: a color name (default value: blue)
weechat.color.nicklist_prefix5
description: text color for prefix #5 in nicklist
type: color
values: a color name (default value: brown)
weechat.color.separator
description: background color for window separators (when split)
type: color
values: a color name (default value: blue)
weechat.color.status_data_highlight
description: text color for buffer with highlight (status bar)
type: color
values: a color name (default value: lightmagenta)
weechat.color.status_data_msg
description: text color for buffer with new messages (status bar)
type: color
values: a color name (default value: yellow)
weechat.color.status_data_other
description: text color for buffer with new data (not messages) (status bar)
type: color
values: a color name (default value: default)
weechat.color.status_data_private
description: text color for buffer with private message (status bar)
type: color
values: a color name (default value: lightgreen)
weechat.color.status_filter
description: text color for filter indicator in status bar
type: color
values: a color name (default value: green)
weechat.color.status_more
description: text color for buffer with new data (status bar)
type: color
values: a color name (default value: yellow)
weechat.color.status_name
description: text color for current buffer name in status bar
type: color
values: a color name (default value: white)
weechat.color.status_number
description: text color for current buffer number in status bar
type: color
values: a color name (default value: yellow)
weechat.color.status_time
description: text color for time (status bar)
type: color
values: a color name (default value: default)
weechat.completion.default_template
description: default completion template (please see documentation for template codes and values)
type: string
values: any string (default value: "%(nicks)|%(irc_channels)")
weechat.completion.nick_add_space
description: add space after nick completion (when nick is not first word on command line)
type: boolean
values: on, off (default value: on)
weechat.completion.nick_completer
description: string inserted after nick completion
type: string
values: any string (default value: ":")
weechat.completion.nick_first_only
description: complete only with first nick found
type: boolean
values: on, off (default value: off)
weechat.completion.nick_ignore_chars
description: chars ignored for nick completion
type: string
values: any string (default value: "[]-^")
weechat.completion.partial_completion_alert
description: alert user when a partial completion occurs
type: boolean
values: on, off (default value: on)
weechat.completion.partial_completion_command
description: partially complete command names (stop when many commands found begin with same letters)
type: boolean
values: on, off (default value: off)
weechat.completion.partial_completion_command_arg
description: partially complete command arguments (stop when many arguments found begin with same prefix)
type: boolean
values: on, off (default value: off)
weechat.completion.partial_completion_count
description: display count for each partial completion in bar item
type: boolean
values: on, off (default value: on)
weechat.completion.partial_completion_other
description: partially complete outside commands (stop when many words found begin with same letters)
type: boolean
values: on, off (default value: off)
weechat.history.display_default
description: maximum number of commands to display by default in history listing (0 = unlimited)
type: integer
values: 0 .. 2147483647 (default value: 5)
weechat.history.max_commands
description: maximum number of user commands in history (0 = unlimited)
type: integer
values: 0 .. 2147483647 (default value: 100)
weechat.history.max_lines
description: maximum number of lines in history per buffer (0 = unlimited)
type: integer
values: 0 .. 2147483647 (default value: 4096)
weechat.history.max_visited_buffers
description: maximum number of visited buffers to keep in memory
type: integer
values: 0 .. 1000 (default value: 50)
weechat.look.buffer_notify_default
description: default notify level for buffers (used to tell WeeChat if buffer must be displayed in hotlist or not, according to importance of message)
type: integer
values: none, highlight, message, all (default value: all)
weechat.look.buffer_time_format
description: time format for buffers
type: string
values: any string (default value: "%H:%M:%S")
weechat.look.color_nicks_number
description: number of colors to use for nicks colors
type: integer
values: 1 .. 10 (default value: 10)
weechat.look.color_real_white
description: 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, off (default value: off)
weechat.look.day_change
description: display special message when day changes
type: boolean
values: on, off (default value: on)
weechat.look.day_change_time_format
description: time format for date displayed when day changed
type: string
values: any string (default value: "%a, %d %b %Y")
weechat.look.highlight
description: comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)
type: string
values: any string (default value: "")
weechat.look.hline_char
description: char used to draw horizontal lines, note that empty value will draw a real line with ncurses, but may cause bugs with URL selection under some terminals
type: string
values: any string (default value: "-")
weechat.look.hotlist_names_count
description: max number of names in hotlist (0 = no name displayed, only buffer numbers)
type: integer
values: 0 .. 32 (default value: 3)
weechat.look.hotlist_names_length
description: max length of names in hotlist (0 = no limit)
type: integer
values: 0 .. 32 (default value: 0)
weechat.look.hotlist_names_level
description: 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: 1 .. 15 (default value: 12)
weechat.look.hotlist_names_merged_buffers
description: if set, force display of names in hotlist for merged buffers
type: boolean
values: on, off (default value: off)
weechat.look.hotlist_short_names
description: if set, uses short names to display buffer names in hotlist (start after first . in name)
type: boolean
values: on, off (default value: on)
weechat.look.hotlist_sort
description: hotlist sort type (group_time_asc (default), group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc)
type: integer
values: group_time_asc, group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc (default value: group_time_asc)
weechat.look.item_time_format
description: time format for "time" bar item
type: string
values: any string (default value: "%H:%M")
weechat.look.jump_current_to_previous_buffer
description: jump to previous buffer displayed when jumping to current buffer number with /buffer *N (where N is a buffer number), to easily switch to another buffer, then come back to current buffer
type: boolean
values: on, off (default value: on)
weechat.look.jump_previous_buffer_when_closing
description: jump to previously visited buffer when closing a buffer (if disabled, then jump to buffer number - 1)
type: boolean
values: on, off (default value: on)
weechat.look.nickmode
description: display nick mode ((half)op/voice) before each nick
type: boolean
values: on, off (default value: on)
weechat.look.nickmode_empty
description: display space if nick mode is not (half)op/voice
type: boolean
values: on, off (default value: off)
weechat.look.paste_max_lines
description: max number of lines for paste without asking user (0 = disable this feature)
type: integer
values: 0 .. 2147483647 (default value: 3)
weechat.look.prefix_action
description: prefix for action messages
type: string
values: any string (default value: " *")
weechat.look.prefix_align
description: prefix alignment (none, left, right (default))
type: integer
values: none, left, right (default value: right)
weechat.look.prefix_align_max
description: max size for prefix (0 = no max size)
type: integer
values: 0 .. 128 (default value: 0)
weechat.look.prefix_align_more
description: display + if prefix is truncated
type: boolean
values: on, off (default value: on)
weechat.look.prefix_buffer_align
description: prefix alignment for buffer name, when many buffers are merged with same number (none, left, right (default))
type: integer
values: none, left, right (default value: right)
weechat.look.prefix_buffer_align_max
description: max size for buffer name, when many buffers are merged with same number (0 = no max size)
type: integer
values: 0 .. 128 (default value: 0)
weechat.look.prefix_buffer_align_more
description: display + if buffer name is truncated (when many buffers are merged with same number)
type: boolean
values: on, off (default value: on)
weechat.look.prefix_error
description: prefix for error messages
type: string
values: any string (default value: "=!=")
weechat.look.prefix_join
description: prefix for join messages
type: string
values: any string (default value: "-→")
weechat.look.prefix_network
description: prefix for network messages
type: string
values: any string (default value: "--")
weechat.look.prefix_quit
description: prefix for quit messages
type: string
values: any string (default value: "←-")
weechat.look.prefix_suffix
description: string displayed after prefix
type: string
values: any string (default value: "|")
weechat.look.read_marker
description: use a marker (line or char) on buffers to show first unread line
type: integer
values: none, line, dotted-line, char (default value: dotted-line)
weechat.look.save_config_on_exit
description: save configuration file on exit
type: boolean
values: on, off (default value: on)
weechat.look.save_layout_on_exit
description: save layout on exit (buffers, windows, or both)
type: integer
values: none, buffers, windows, all (default value: none)
weechat.look.scroll_amount
description: how many lines to scroll by with scroll_up and scroll_down
type: integer
values: 1 .. 2147483647 (default value: 3)
weechat.look.scroll_page_percent
description: percent of screen to scroll when scrolling one page up or down (for example 100 means one page, 50 half-page)
type: integer
values: 1 .. 100 (default value: 100)
weechat.look.search_text_not_found_alert
description: alert user when text sought is not found in buffer
type: boolean
values: on, off (default value: on)
weechat.look.set_title
description: set title for window (terminal for Curses GUI) with name and version
type: boolean
values: on, off (default value: on)
weechat.network.gnutls_ca_file
description: file containing the certificate authorities
type: string
values: any string (default value: "%h/ssl/CAs.pem")
weechat.plugin.autoload
description: comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "perl.so")
type: string
values: any string (default value: "*")
weechat.plugin.debug
description: enable debug messages by default in all plugins (option disabled by default, which is highly recommended)
type: boolean
values: on, off (default value: off)
weechat.plugin.extension
description: standard plugins extension in filename (for example ".so" under Linux or ".dll" under Microsoft Windows)
type: string
values: any string (default value: ".so")
weechat.plugin.path
description: path for searching plugins ("%h" will be replaced by WeeChat home, "~/.weechat" by default)
type: string
values: any string (default value: "%h/plugins")
weechat.plugin.save_config_on_unload
description: save configuration files when unloading plugins
type: boolean
values: on, off (default value: on)
weechat.startup.command_after_plugins
description: command executed when WeeChat starts, after loading plugins
type: string
values: any string (default value: "")
weechat.startup.command_before_plugins
description: command executed when WeeChat starts, before loading plugins
type: string
values: any string (default value: "")
weechat.startup.display_logo
description: display WeeChat logo at startup
type: boolean
values: on, off (default value: on)
weechat.startup.display_version
description: display WeeChat version at startup
type: boolean
values: on, off (default value: on)
weechat.startup.weechat_slogan
description: WeeChat slogan (if empty, slogan is not used)
type: string
values: any string (default value: "le client de discussion le plus geek !")
Colors for Curses GUI are:
default |
default terminal color (transparent for background) |
black |
black |
darkgray |
dark gray |
red |
dark red |
lightred |
light red |
green |
dark green |
lightgreen |
light green |
brown |
brown |
yellow |
yellow |
blue |
dark blue |
lightblue |
light blue |
magenta |
dark magenta |
lightmagenta |
light magenta |
cyan |
dark cyan |
lightcyan |
light cyan |
white |
white |
manage bars add: add a new bar barname: name of bar (must be unique) type: root: outside windows, window: inside windows, with optional conditions (see below) cond1,...: condition(s) for displaying bar (only for type "window"): active: on active window inactive: on inactive windows nicklist: on windows with nicklist without condition, bar is always displayed position: bottom, top, left or right size: size of bar (in chars) separator: 1 for using separator (line), 0 or nothing means no separator item1,...: items for this bar (items can be separated by comma (space between items) or "+" (glued items)) default: create default bars del: delete a bar (or all bars with -all) set: set a value for a bar property option: option to change (for options list, look at /set weechat.bar.<barname>.*) value: new value for option hide: hide a bar show: show an hidden bar toggle: hide/show a bar scroll: scroll bar up/down buffer: name of buffer to scroll ('*' means current buffer, you should use '*' for root bars) scroll_value: value for scroll: 'x' or 'y', followed by '+', '-', 'b' (beginning) or 'e' (end), value (for +/-), and optional %% (to scroll by %% of width/height, otherwise value is number of chars) list: list all bars listfull: list all bars (verbose) listitems: list all bar items Examples: create a bar with time, buffer number + name, and completion: /bar add mybar root bottom 1 0 [time],buffer_number+:+buffer_name,completion hide a bar: /bar hide mybar scroll nicklist 10 lines down on current buffer: /bar scroll nicklist * y+10 scroll nicklist one page up on #weechat buffer: /bar scroll nicklist #weechat y-100% scroll to end of nicklist on current buffer: /bar scroll nicklist * ye
manage buffers clear: clear buffer content (number for a buffer, -merged for merged buffers, -all for all buffers, or nothing for current buffer) move: move buffer in the list (may be relative, for example -1) merge: merge current buffer to another buffer (chat area will be mix of both buffers) (by default ctrl-x switches between merged buffers) unmerge: unmerge buffer from other buffers which have same number close: close buffer (number/range is optional) list: list buffers (no parameter implies this list) notify: set notify level for current buffer: this level determines whether buffer will be added to hotlist or not: none: never highlight: for highlights only message: for messages from users + highlights all: all messages reset: reset to default value (all) localvar: display local variables for current buffer set: set a property for current buffer number: jump to buffer by number, possible prefix: '+': relative jump, add number to current '-': relative jump, sub number to current '*': jump to number, using option "weechat.look.jump_current_to_previous_buffer" name: jump to buffer by (partial) name Examples: clear current buffer: /buffer clear clear all buffers: /buffer clear -all move buffer: /buffer move 5 merge with core buffer: /buffer merge 1 unmerge buffer: /buffer unmerge close current buffer: /buffer close close buffers 5 to 7: /buffer close 5-7 jump to #weechat: /buffer #weechat jump to next buffer: /buffer +1
launch explicit WeeChat or plugin command plugin: plugin name ('weechat' for WeeChat internal command) command: command to execute (a '/' is automatically added if not found at beginning of command)
control debug for core/plugins set: set log level for plugin plugin: name of plugin ("core" for WeeChat core) level: debug level for plugin (0 = disable debug) dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes) buffer: dump buffer content with hexadecimal values in log file windows: display windows tree term: display infos about terminal and available colors
filter messages in buffers, to hide/show them according to tags or regex list: list all filters enable: enable filters (filters are enabled by default) disable: disable filters toggle: toggle filters name: filter name add: add a filter del: delete a filter -all: delete all filters plugin.buffer: plugin and buffer where filter is active ("*" for all buffers) tags: comma separated list of tags, for example: "irc_join,irc_part,irc_quit" regex: regular expression to search in line (use \t to separate prefix from message, special chars like '|' must be escaped: '\|') The default key alt+'=' toggles filtering on/off. Examples: use IRC smart filter for join/part/quit messages: /filter add irc_smart * irc_smart_filter * filter all IRC join/part/quit messages: /filter add joinquit * irc_join,irc_part,irc_quit * filter nick "toto" on IRC channel #weechat: /filter add toto irc.freenode.#weechat * toto\t filter lines containing word "spam": /filter add filterspam * * spam filter lines containing "weechat sucks" on IRC channel #weechat: /filter add sucks irc.freenode.#weechat * weechat sucks
display help about commands and options command: a command name option: an option name (use /set to see list)
show buffer command history clear: clear history value: number of history entries to show
functions for command line This command is used by key bindings or plugins.
bind/unbind keys bind: bind a command to a key or display command bound to key unbind: remove a key binding reset: restore bindings to the default values and delete ALL personal bindings (use carefully!) missing: add missing keys (using default bindings) When binding a command to a key, it is recommended to use key alt+k (or Esc then k), and then press the key to bind: this will insert key code in command line.
save/apply/reset layout for buffers and windows save: save current layout apply: apply saved layout reset: remove saved layout buffers: save/apply only buffers (order of buffers) windows: save/apply only windows (buffer displayed by each window) Without argument, this command displays saved layout.
list/load/unload plugins list: list loaded plugins listfull: list loaded plugins (verbose) load: load a plugin autoload: autoload plugins in system or user directory reload: reload one plugin (if no name given, unload all plugins, then autoload plugins) unload: unload one or all plugins Without argument, this command lists loaded plugins.
manage proxies add: add a new proxy proxyname: name of proxy (must be unique) type: http, socks4 or socks5 address: IP or hostname port: port username: username (optional) password: password (optional) del: delete a proxy (or all proxies with -all) set: set a value for a proxy property option: option to change (for options list, look at /set weechat.proxy.<proxyname>.*) value: new value for option list: list all proxies Examples: create a http proxy, running on local host, port 8888: /proxy add local http 127.0.0.1 8888 create a http proxy using IPv6 protocol: /proxy add local http 127.0.0.1 8888 /proxy set local ipv6 on create a socks5 proxy with username/password: /proxy add myproxy socks5 sample.host.org 3128 myuser mypass delete a proxy: /proxy del myproxy
quit WeeChat arguments: text sent with signal "quit" (for example irc plugin uses this text to send quit message to server)
reload configuration files from disk file: configuration file to reload Without argument, all files (WeeChat and plugins) are reloaded.
save configuration files to disk file: configuration file to save Without argument, all files (WeeChat and plugins) are saved.
set config options option: name of an option value: new value for option New value can be, according to variable type: boolean: on, off or toggle integer: number, ++number or --number string : any string ("" for empty string) color : color name, ++number or --number For all types, you can use null to remove option value (undefined value). This works only for some special plugin variables.
unset/reset config options option: name of an option (may begin or end with "*" to mass-reset options, use carefully!) According to option, it's reset (for standard options) or removed (for optional settings, like server values).
upgrade WeeChat without disconnecting from servers path_to_binary: path to WeeChat binary (default is current binary) This command run again a WeeChat binary, so it should have been compiled or installed with a package manager before running this command.
show WeeChat uptime -o: send uptime to current buffer as input
show WeeChat version and compilation date -o: send version to current buffer as input
schedule a command execution in future number: amount of time to wait (integer number) unit: optional, values are: ms: milliseconds s: seconds (default) m: minutes h: hours command: command to execute (or text to send to buffer if command does not start with '/') Note: command is executed on buffer where /wait was executed (if buffer is not found (for example if it has been closed before execution of command), then command is executed on WeeChat core buffer). Examples: join channel in 10 sec: /wait 10 /join #test set away in 15 min: /wait 15m /away -all I'm away say 'hello' in 2 min: /wait 2m hello
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> percentage of parent window merge: merge window with another (all = keep only one window) page_up: scroll one page up page_down: scroll one page down refresh: refresh screen scroll: scroll number of lines (+/-N) or with time: s=seconds, m=minutes, h=hours, d=days, M=months, y=years scroll_up: scroll a few lines up scroll_down: scroll a few lines down scroll_top: scroll to top of buffer scroll_bottom: scroll to bottom of buffer scroll_previous_highlight: scroll to previous highlight scroll_next_highlight: scroll to next highlight zoom: zoom on window For splith and splitv, pct is a percentage 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 Examples: jump to window displaying buffer #1: /window b1 scroll 2 lines up: /window scroll -2 scroll 2 days up: /window scroll -2d scroll to beginning of current day: /window scroll -d
To learn more about plugin or script development (through API), please read WeeChat Plugin API Reference or WeeChat Scripting Guide.
A plugin is dynamic library, written in C and compiled, which is loaded by WeeChat. Under GNU/Linux, the file has ".so" extension, ".dll" under Windows.
Plugins found are automatically loaded when WeeChat is starting, and it is possible to load or unload plugins while WeeChat is running.
It’s important to make difference between a plugin and a script: a plugin is a binary file compiled and loaded with command /plugin, whereas a script is a text file loaded with a plugin like perl with command /perl.
You can use command /plugin to load/unload a plugin, or list all loaded plugins. When a plugin is unloaded, all buffers created by this plugin are automatically closed.
Examples to load, unload or list plugins:
/plugin load irc /plugin unload irc /plugin list
Default plugins are:
Plugin | Description |
---|---|
alias |
Define alias for commands |
aspell |
Spell checking for command line |
charset |
Charset decoding/encoding for buffers |
demo |
Demo plugin (not compiled by default) |
fifo |
FIFO pipe used to remotely send commands to WeeChat |
irc |
IRC chat protocol |
logger |
Log buffers to files |
perl |
Perl scripting API |
python |
Python scripting API |
ruby |
Ruby scripting API |
lua |
Lua scripting API |
tcl |
Tcl scripting API |
xfer |
File transfer and direct chat |
Alias plugin lets you create alias for commands (from WeeChat or other plugins).
create an alias for a command alias_name: name of alias (can start or end with "*" for alias listing) command: command name (many commands can be separated by semicolons) arguments: arguments for command Without argument, this command lists all defined alias. Note: in command, special variables are replaced: $n: argument 'n' (between 1 and 9) $-m: arguments from 1 to 'm' $n-: arguments from 'n' to last $n-m: arguments from 'n' to 'm' $*: all arguments $~: last argument $nick: current nick $channel: current channel $server: current server
Aspell plugin lets you check spelling in command line. It is possible to use many languages by buffer.
aspell.check.commands
description: comma separated list of commands for which spell checking is enabled (spell checking is disabled for all other commands)
type: string
values: any string (default value: "ame,amsg,away,command,cycle,kick,kickban,me,msg,notice,part,query,quit,topic")
aspell.check.default_dict
description: default dictionary (or comma separated list of dictionaries) to use when buffer has no dictionary defined (leave blank to disable aspell on buffers for which you didn’t explicitly enabled it)
type: string
values: any string (default value: "")
aspell.check.during_search
description: check words during text search in buffer
type: boolean
values: on, off (default value: off)
aspell.check.real_time
description: real-time spell checking of words (slower, disabled by default: words are checked only if there’s delimiter after)
type: boolean
values: on, off (default value: off)
aspell.check.word_min_length
description: minimum length for a word to be spell checked (use 0 to check all words)
type: integer
values: 0 .. 2147483647 (default value: 2)
aspell.look.color
description: color used for misspelled words
type: color
values: a color name (default value: lightred)
aspell plugin configuration dictlist: show installed dictionaries enable: enable aspell on current buffer disable: disable aspell on current buffer addword: add a word in your personal aspell dictionary Input line beginning with a '/' is not checked, except for some commands.
Charset plugin lets you decode or encode data using charsets.
There is default charset for decode/encode, and specific charsets for buffers (or group of buffers).
This plugin is optional, but recommended: if it’s not loaded, WeeChat can only read/write UTF-8 data.
Charset plugin should be autoloaded by WeeChat. To be sure plugin is loaded, try:
/charset
If command is not found, then load plugin with command:
/plugin load charset
If plugin is not found, then you should compile again WeeChat with plugins and Charset support.
When Charset plugin starts, it displays terminal and internal charsets. Terminal charset depends on your locale, and internal is UTF-8.
For example:
charset: terminal: ISO-8859-15, internal: UTF-8
charset.default.decode
description: global decoding charset
type: string
values: any string (default value: "iso-8859-1")
charset.default.encode
description: global encoding charset
type: string
values: any string (default value: "")
change charset for current buffer decode: change decoding charset encode: change encoding charset charset: new charset for current buffer reset: reset charsets for current buffer
To set global decode and encode charsets, use command /set.
For example:
/set charset.default.decode ISO-8859-15 /set charset.default.encode ISO-8859-15
If global decode charset is not set (for example during first load of Charset plugin), it will be automatically set to terminal charset (if it’s different from UTF-8), or by default to ISO-8859-1.
Default encode value is empty, so it sends by default with internal charset (UTF-8).
To set IRC server charset, use command /charset on server buffer. If you give only charset, then it will set decoding and encoding values.
For example:
/charset ISO-8859-15
It’s equivalent to:
/charset decode ISO-8859-15 /charset encode ISO-8859-15
To set IRC channel (or private) charset, use same commands as server, but on channel (or private) buffer.
To see all charsets used, use following command:
/set charset.*
For any problem with charsets, please look at WeeChat FAQ.
You can remote control WeeChat, by sending commands or text to a FIFO pipe (if option "plugins.var.fifo.fifo" is enabled, it is by default).
The FIFO pipe is located in ~/.weechat/ and is called weechat_fifo_xxxx (where xxxx is the process ID (PID) of running WeeChat).
Syntax for the FIFO pipe commands/text is one of following:
plugin.buffer *text or command here *text or command here
Some examples:
nick change on IRC server freenode to "newnick":
$ echo 'irc.server.freenode */nick newnick' >~/.weechat/weechat_fifo_12345
display text on IRC #weechat channel:
$ echo 'irc.freenode.#weechat *hello!' >~/.weechat/weechat_fifo_12345
display text on current buffer:
$ echo '*hello!' >~/.weechat/weechat_fifo_12345
send two commands to unload/reload Perl scripts (you have to separate them with "\n"):
$ echo -e '*/perl unload\n*/perl autoload' >~/.weechat/weechat_fifo_12345
You can write a script to send command to all running WeeChat at same time, for example:
#!/bin/sh if [ $# -eq 1 ]; then for fifo in ~/.weechat/weechat_fifo_* do echo -e "$1" >$fifo done fi
If the script is called "auto_weechat_command", you can run it with:
$ ./auto_weechat_command 'irc.freenode.#weechat *hello'
The IRC plugin is designed to chat through IRC protocol with other people.
It is multi-servers, and offers all supported IRC commands including DCC chat and file transfer (via xfer plugin, see [xfer_plugin]).
It is possible to give URL for one or many IRC servers, as follow:
irc[6][s]://[pseudo[:mot_passe]@]irc.example.org[:port][/channel][,channel[...]
Example to join #weechat and #toto on server irc.freenode.net server, default port (6667), with nick nono:
$ weechat-curses irc://nono@irc.freenode.net/#weechat,#toto
irc.color.input_nick
description: color for nick in input bar
type: color
values: a color name (default value: lightcyan)
irc.color.item_away
description: color for away item
type: color
values: a color name (default value: yellow)
irc.color.item_channel_modes
description: color for channel modes, near channel name
type: color
values: a color name (default value: default)
irc.color.message_join
description: color for text in join messages
type: color
values: a color name (default value: green)
irc.color.message_quit
description: color for text in part/quit messages
type: color
values: a color name (default value: red)
irc.color.notice
description: color for text "Notice" in notices
type: color
values: a color name (default value: green)
irc.look.color_nicks_in_server_messages
description: use nick color in messages from server
type: boolean
values: on, off (default value: on)
irc.look.color_pv_nick_like_channel
description: use same nick color for channel and private
type: boolean
values: on, off (default value: on)
irc.look.display_away
description: display message when (un)marking as away
type: integer
values: off, local, channel (default value: local)
irc.look.display_channel_modes
description: display channel modes in "buffer_name" bar item
type: boolean
values: on, off (default value: on)
irc.look.display_ctcp_blocked
description: display CTCP message even if it is blocked
type: boolean
values: on, off (default value: on)
irc.look.display_ctcp_reply
description: display CTCP reply sent by WeeChat
type: boolean
values: on, off (default value: on)
irc.look.display_ctcp_unknown
description: display CTCP message even if it is unknown CTCP
type: boolean
values: on, off (default value: on)
irc.look.display_nick_modes
description: display nick modes in "input_prompt" bar item
type: boolean
values: on, off (default value: on)
irc.look.display_old_topic
description: display old topic when channel topic is changed
type: boolean
values: on, off (default value: on)
irc.look.hide_nickserv_pwd
description: hide password displayed by nickserv
type: boolean
values: on, off (default value: on)
irc.look.highlight_tags
description: comma separated list of tags for messages that may produce highlight (usually any message from another user, not server messages,..)
type: string
values: any string (default value: "irc_privmsg,irc_notice")
irc.look.item_display_server
description: name of bar item where IRC server is displayed (for status bar)
type: integer
values: buffer_plugin, buffer_name (default value: buffer_plugin)
irc.look.msgbuffer_fallback
description: default target buffer for msgbuffer options when target is private and that private buffer is not found
type: integer
values: current, server (default value: current)
irc.look.nick_completion_smart
description: smart completion for nicks (completes first with last speakers)
type: integer
values: off, speakers, speakers_highlights (default value: speakers)
irc.look.nick_prefix
description: text to display before nick in chat window
type: string
values: any string (default value: "")
irc.look.nick_suffix
description: text to display after nick in chat window
type: string
values: any string (default value: "")
irc.look.notice_as_pv
description: display notices as private messages (if auto, use private buffer if found)
type: integer
values: auto, never, always (default value: auto)
irc.look.open_channel_near_server
description: open new channels near server
type: boolean
values: on, off (default value: off)
irc.look.open_pv_near_server
description: open new privates near server
type: boolean
values: on, off (default value: off)
irc.look.raw_messages
description: number of IRC raw messages to save in memory when raw data buffer is closed (messages will be displayed when opening raw data buffer)
type: integer
values: 0 .. 65535 (default value: 256)
irc.look.server_buffer
description: merge server buffers
type: integer
values: merge_with_core, merge_without_core, independent (default value: merge_with_core)
irc.look.show_away_once
description: show remote away message only once in private
type: boolean
values: on, off (default value: on)
irc.look.smart_filter
description: filter join/part/quit messages for a nick if not speaking for some minutes on channel (you must create a filter on tag "irc_smart_filter")
type: boolean
values: on, off (default value: off)
irc.look.smart_filter_delay
description: delay for filtering join/part/quit messages (in minutes)
type: integer
values: 1 .. 10080 (default value: 5)
irc.look.topic_strip_colors
description: strip colors in topic (used only when displaying buffer title)
type: boolean
values: on, off (default value: off)
irc.network.anti_flood_prio_high
description: anti-flood for high priority queue: number of seconds between two user messages or commands sent to IRC server (0 = no anti-flood)
type: integer
values: 0 .. 60 (default value: 2)
irc.network.anti_flood_prio_low
description: anti-flood for low priority queue: number of seconds between two messages sent to IRC server (messages like automatic CTCP replies) (0 = no anti-flood)
type: integer
values: 0 .. 60 (default value: 2)
irc.network.away_check
description: interval between two checks for away (in minutes, 0 = never check)
type: integer
values: 0 .. 2147483647 (default value: 0)
irc.network.away_check_max_nicks
description: do not check away nicks on channels with high number of nicks (0 = unlimited)
type: integer
values: 0 .. 2147483647 (default value: 25)
irc.network.colors_receive
description: when off, colors codes are ignored in incoming messages
type: boolean
values: on, off (default value: on)
irc.network.colors_send
description: allow user to send colors with special codes (ctrl-c + a code and optional color: b=bold, cxx=color, cxx,yy=color+background, u=underline, r=reverse)
type: boolean
values: on, off (default value: on)
irc.network.default_msg_part
description: default part message (leaving channel) ("%v" will be replaced by WeeChat version in string)
type: string
values: any string (default value: "WeeChat %v")
irc.network.default_msg_quit
description: default quit message (disconnecting from server) ("%v" will be replaced by WeeChat version in string)
type: string
values: any string (default value: "WeeChat %v")
irc.network.lag_check
description: interval between two checks for lag (in seconds, 0 = never check)
type: integer
values: 0 .. 2147483647 (default value: 60)
irc.network.lag_disconnect
description: disconnect after important lag (in minutes, 0 = never disconnect)
type: integer
values: 0 .. 2147483647 (default value: 0)
irc.network.lag_min_show
description: minimum lag to show (in seconds)
type: integer
values: 0 .. 2147483647 (default value: 1)
irc.network.send_unknown_commands
description: send unknown commands to server
type: boolean
values: on, off (default value: off)
irc.server_default.addresses
description: list of hostname/port or IP/port for server (separated by comma)
type: string
values: any string (default value: "")
irc.server_default.autoconnect
description: automatically connect to server when WeeChat is starting
type: boolean
values: on, off (default value: off)
irc.server_default.autojoin
description: comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")
type: string
values: any string (default value: "")
irc.server_default.autoreconnect
description: automatically reconnect to server when disconnected
type: boolean
values: on, off (default value: on)
irc.server_default.autoreconnect_delay
description: delay (in seconds) before trying again to reconnect to server
type: integer
values: 0 .. 65535 (default value: 30)
irc.server_default.autorejoin
description: automatically rejoin channels after kick
type: boolean
values: on, off (default value: off)
irc.server_default.autorejoin_delay
description: delay (in seconds) before autorejoin (after kick)
type: integer
values: 0 .. 86400 (default value: 30)
irc.server_default.command
description: command(s) to run when connected to server (many commands should be separated by ";", use "\;" for a semicolon, special variables $nick, $channel and $server are replaced by their value)
type: string
values: any string (default value: "")
irc.server_default.command_delay
description: delay (in seconds) after command was executed (example: give some time for authentication)
type: integer
values: 0 .. 3600 (default value: 0)
irc.server_default.ipv6
description: use IPv6 protocol for server communication
type: boolean
values: on, off (default value: off)
irc.server_default.local_hostname
description: custom local hostname/IP for server (optional, if empty local hostname is used)
type: string
values: any string (default value: "")
irc.server_default.nicks
description: nicknames to use on server (separated by comma)
type: string
values: any string (default value: "")
irc.server_default.password
description: password for server
type: string
values: any string (default value: "")
irc.server_default.proxy
description: proxy used for this server (optional)
type: string
values: any string (default value: "")
irc.server_default.realname
description: real name to use on server
type: string
values: any string (default value: "")
irc.server_default.ssl
description: use SSL for server communication
type: boolean
values: on, off (default value: off)
irc.server_default.ssl_cert
description: ssl certificate file used to automatically identify your nick
type: string
values: any string (default value: "")
irc.server_default.ssl_dhkey_size
description: size of the key used during the Diffie-Hellman Key Exchange
type: integer
values: 0 .. 2147483647 (default value: 2048)
irc.server_default.ssl_verify
description: check that the ssl connection is fully trusted
type: boolean
values: on, off (default value: on)
irc.server_default.username
description: user name to use on server
type: string
values: any string (default value: "")
find information about the administrator of the server target: server
execute a command on all channels of all connected servers -current: execute command for channels of current server only -exclude: exclude some channels ('*' is allowed at beginning or end of channel name, to exclude many channels) command: command to execute arguments: arguments for command Examples: execute '/me is testing' on all channels: /allchan me is testing say 'hello' everywhere but not on #weechat: /allchan -exclude=#weechat msg * hello say 'hello' everywhere but not on #weechat and channels beginning with #linux: /allchan -exclude=#weechat,#linux* msg * hello
execute a command on all connected servers -exclude: exclude some servers ('*' is allowed at beginning or end of server name, to exclude many servers) command: command to execute arguments: arguments for command Examples: change nick on all servers: /allserv nick newnick set away on all servers: /allserv away I'm away
toggle away status -all: toggle away status on all connected servers message: message for away (if no message is given, away status is removed)
ban nicks or hosts channel: channel for ban nickname: user or host to ban
connect to IRC server(s) -all: connect to all servers servername: internal server name to connect (server must have been created by /server add) -nojoin: do not join any channel (even if autojoin is enabled on server) hostname: hostname (or IP) of a server port: port for server (6667 by default) option: set option for server (for boolean option, value can be omitted) nooption: set boolean option to 'off' (for example: -nossl) Examples: /connect freenode /connect irc.oftc.net/6667 /connect irc6.oftc.net/6667 -ipv6 /connect irc6.oftc.net/6697 -ipv6 -ssl /connect my.server.org/6697 -ssl -password=test
send a CTCP message (Client-To-Client Protocol) receiver: nick or channel to send CTCP to type: CTCP type (examples: "version", "ping", ..) arguments: arguments for CTCP
leave and rejoin a channel channel: channel name for cycle part_message: part message (displayed to other users)
start DCC (file or chat) action: 'send' (file) or 'chat' nickname: nickname to send file or chat file: filename (on local host)
remove half channel operator status from nickname(s)
remove channel operator status from nickname(s)
remove voice from nickname(s)
shutdown the server
disconnect from IRC server(s) -all: disconnect from all servers servername: server name to disconnect
give half channel operator status to nickname(s)
ignore nicks/hosts from servers or channels list: list all ignores add: add a ignore del: del a ignore number: number of ignore to delete (look at list to find it) -all: delete all ignores nick/host: nick or host to ignore: syntax is "re:regex" or "mask" (a mask is a string with some "*" to replace one or more chars) server: internal server name where ignore is working channel: channel name where ignore is working Examples: ignore nick "toto" everywhere: /ignore add toto ignore host "toto@domain.com" on freenode server: /ignore add toto@domain.com freenode ignore host "toto*@*.domain.com" on freenode/#weechat: /ignore add toto*@*.domain.com freenode #weechat
get information describing the server target: server name
invite a nick on a channel nickname: nick to invite channel: channel to invite
check if a nickname is currently on IRC nickname: nickname
join a channel channel: channel name to join key: key to join the channel
forcibly remove a user from a channel channel: channel where user is nickname: nickname to kick comment: comment for kick
kicks and bans a nick from a channel channel: channel where user is nickname: nickname to kick and ban comment: comment for kick It is possible to kick/ban with a mask, nick will be extracted from mask and replaced by "*", for example: /kickban toto!*@host.com will ban "*!*@host.com" and then kick "toto".
close client-server connection nickname: nickname comment: comment for kill
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
list channels and their topic channel: channel to list (a regexp is allowed) server: server name
get statistics about the size of the IRC network mask: servers matching the mask only target: server for forwarding request
send a CTCP action to the current channel message: message to send
change channel or user mode channel modes: channel: channel name to modify (default is current one) 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
get the "Message Of The Day" target: server name
send message to a nick or channel server: send to this server (internal name) receiver: nick or channel (may be mask, '*' = current channel) text: text to send
list nicknames on channels channel: channel name
change current nickname -all: set new nickname for all connected servers nickname: new nickname
send notice message to user server: send to this server (internal name) nickname: user to send notice to text: text to send
give channel operator status to nickname(s)
get operator privileges user/password: used to get privileges on current IRC server
leave a channel channel: channel name to leave part_message: part message (displayed to other users)
ping server server1: server to ping server2: forward ping to this server
answer to a ping message daemon: daemon who has responded to Ping message daemon2: forward message to this daemon
send a private message to a nick server: send to this server (internal name) nickname: nickname for private conversation text: text to send
send raw data to server without parsing server: send to this server (internal name) data: raw data to send
reconnect to server(s) -all: reconnect to all servers servername: server name to reconnect -nojoin: do not join any channel (even if autojoin is enabled on server)
tell the server to reload its config file option: extra option, for some servers
tell the server to restart itself
forces a user to join channel(s) nickname: nickname channel: channel name
change mode on channel, without having operator status channel: channel name mode: mode for channel
forces a user to use another nick nickname: nickname new_nickname: new nickname
forces a user to leave channel(s) nickname: nickname channel: channel name
forces a user to quit server with a reason nickname: nickname reason: reason
list, add or remove IRC servers list: list servers (no parameter implies this list) listfull: list servers with detailed info for each server add: create a new server servername: server name, for internal and display use hostname: name or IP address of server, with optional port (default: 6667) temp: create temporary server (not saved) option: set option for server (for boolean option, value can be omitted) nooption: set boolean option to 'off' (for example: -nossl) copy: duplicate a server rename: rename a server keep: keep server in config file (for temporary servers only) del: delete a server deloutq: delete messages out queue for all servers (all messages WeeChat is currently sending) jump: jump to server buffer raw: open buffer with raw IRC data Examples: /server listfull /server add oftc irc.oftc.net/6697 -ssl -autoconnect /server add oftc6 irc6.oftc.net/6697 -ipv6 -ssl /server add freenode2 chat.eu.freenode.net/6667,chat.us.freenode.net/6667 /server copy oftc oftcbis /server rename oftc newoftc /server del freenode /server deloutq
register a new service distribution: visibility of service type: reserved for future usage
list services currently connected to the network mask: list only services matching this mask type: list only services of this type
deliver a message to a service service: name of service text: text to send
disconnect server links server: server name comment: comment for quit
query statistics about server query: c/h/i/k/l/m/o/y/u (see RFC1459) server: server name
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
query local time from server target: query time from specified server
get/set channel topic channel: channel name topic: new topic for channel (if topic is "-delete" then topic is deleted)
find the route to specific server target: server
unban nicks or hosts channel: channel for unban nickname: user or host to unban
return a list of information about nicknames nickname: nickname
list of users logged into the server target: server
give the version info of nick or server (current or specified) server: server name nickname: nickname
give voice to nickname(s)
send a message to all currently connected users who have set the 'w' user mode for themselves text to send
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
query information about user(s) server: server name nickname: nickname (may be a mask)
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
It is possible to customize CTCP replies, or block some CTCP queries (do not reply).
For example, to customize reply to CTCP "VERSION", use following command:
/set irc.ctcp.version "I'm running WeeChat $version, it rocks!"
If you want to block CTCP "VERSION" (do not reply to a query), then set empty string:
/set irc.ctcp.version ""
Even unknown CTCP can be customized, for example you can reply to CTCP "BLABLA":
/set irc.ctcp.blabla "This is my answer to CTCP BLABLA"
It is possible to customize CTCP for one server only, using its internal name before CTCP name:
/set irc.ctcp.freenode.version "WeeChat $version (for freenode)"
If you want to restore standard CTCP reply, then remove option:
/unset irc.ctcp.version
Following codes can be used in strings and are automatically expanded by WeeChat when replying to CTCP:
Code | Description | Value/example |
---|---|---|
$clientinfo |
list of supported CTCP |
ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION |
$version |
WeeChat version |
0.3.0 |
$compilation |
WeeChat compilation date |
Sep 13 2009 |
$osinfo |
info about OS |
Linux 2.6.31 / i686 |
$site |
WeeChat site |
http://www.weechat.org |
$download |
WeeChat site, download page |
http://www.weechat.org/download |
$time |
current date/time |
Sun Sep 13 15:48:31 2009 |
$username |
username on IRC server |
nick |
$realname |
realname on IRC server |
My name |
If CTCP options are not defined (by default), CTCP replies are:
CTCP | Reply format | Example |
---|---|---|
CLIENTINFO |
$clientinfo |
ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION |
FINGER |
WeeChat $version |
WeeChat 0.3.0 |
SOURCE |
$download |
http://www.weechat.org/download |
TIME |
$time |
Sun Sep 13 15:48:31 2009 |
USERINFO |
$username ($realname) |
nick (My name) |
VERSION |
WeeChat $version ($compilation) |
WeeChat 0.3.0 (Sep 13 2009) |
It is possible to customize target buffer for IRC messages (buffer used to display message) with options irc.msgbuffer.*.
For some IRC messages (see list below), you can use value:
current buffer (if it’s IRC buffer, or on server buffer by default)
private buffer for nick, or current/server buffer if not found (according to option irc.look.msgbuffer_fallback)
WeeChat "core" buffer
Default is server buffer (when option is not set).
Non-exhaustive list of IRC messages or alias that you can customize:
message | alias | description |
---|---|---|
invite |
invited on a channel |
|
notice |
notice |
|
wallops |
wallops |
|
221 |
user mode string |
|
275 |
whois |
whois (secure connection) |
303 |
ison |
|
305 |
unaway |
unaway |
306 |
away |
away |
307 |
whois |
whois (registered nick) |
310 |
whois |
whois (help mode) |
311 |
whois |
whois (user) |
312 |
whois |
whois (server) |
313 |
whois |
whois (operator) |
314 |
whowas |
whowas |
315 |
who |
who (end) |
317 |
whois |
whois (idle) |
318 |
whois |
whois (end) |
319 |
whois |
whois (channels) |
320 |
whois |
whois (identified user) |
321 |
list |
list (start) |
322 |
list |
list (channel) |
323 |
list |
list (end) |
326 |
whois |
whois (has oper privs) |
327 |
whois |
whois (host) |
330 |
whois |
whois (logged in as) |
335 |
whois |
whois (is a bot on) |
338 |
whois |
whois (host) |
341 |
inviting |
|
344 |
reop |
channel reop |
345 |
reop |
channel reop (end) |
351 |
server version |
|
352 |
who |
who |
369 |
whowas |
whowas (end) |
378 |
whois |
whois (connecting from) |
379 |
whois |
whois (using modes) |
432 |
erroneous nickname |
|
433 |
nickname already in use |
|
438 |
not authorized to change nickname |
|
671 |
whois |
whois (secure connection) |
901 |
you are now logged in |
Other numeric commands can be customized as well.
Message can be prefixed by server name to be specific to an irc server (for example: freenode.whois).
Some examples:
display result of /whois on private buffer:
/set irc.msgbuffer.whois private
restore default buffer for whois (server buffer):
/unset irc.msgbuffer.whois
display invitation on current buffer, only for "freenode" server:
/set irc.msgbuffer.freenode.invite current
display message "303" (ison) on WeeChat "core" buffer:
/set irc.msgbuffer.303 weechat
The Logger plugin lets you save content of buffers to files, with options about what and how it is saved.
logger.file.auto_log
description: automatically save content of buffers to files (unless a buffer disables log)
type: boolean
values: on, off (default value: on)
logger.file.info_lines
description: write information line in log file when log starts or ends for a buffer
type: boolean
values: on, off (default value: off)
logger.file.mask
description: default file name mask for log files (format is "directory/to/file" or "file", without first "/" because "path" option is used to build complete path to file); local buffer variables are permitted
type: string
values: any string (default value: "$plugin.$name.weechatlog")
logger.file.name_lower_case
description: use only lower case for log filenames
type: boolean
values: on, off (default value: on)
logger.file.path
description: path for WeeChat log files ("%h" will be replaced by WeeChat home, "~/.weechat" by default)
type: string
values: any string (default value: "%h/logs/")
logger.file.replacement_char
description: replacement char for special chars in filename built with mask (like directory delimiter)
type: string
values: any string (default value: "_")
logger.file.time_format
description: timestamp used in log files (see man strftime for date/time specifiers)
type: string
values: any string (default value: "%Y-%m-%d %H:%M:%S")
logger.look.backlog
description: maximum number of lines to display from log file when creating new buffer (0 = no backlog)
type: integer
values: 0 .. 2147483647 (default value: 20)
logger plugin configuration list: show logging status for opened buffers set: set logging level on current buffer level: level for messages to be logged (0 = logging disabled, 1 = a few messages (most important) .. 9 = all messages) disable: disable logging on current buffer (set level to 0) Options "logger.level.*" and "logger.mask.*" can be used to set level or mask for a buffer, or buffers beginning with name. Examples: set level to 5 for current buffer: /logger set 5 disable logging for current buffer: /logger disable set level to 3 for all IRC buffers: /set logger.level.irc 3 disable logging for main WeeChat buffer: /set logger.level.core.weechat 0 use a directory per IRC server and a file per channel inside: /set logger.mask.irc "$server/$channel.weechatlog" Log levels used by IRC plugin: 1: user message, notice, private 2: nick change 3: server message 4: join/part/quit 9: all other messages
Logging is made with a level for each buffer. Default level is 9 (log all messages displayed on buffer). You can change level for one buffer, or a group of buffers.
Possible levels are 0 to 9. Zero means "do not log anything" and 9 means "log all messages".
Plugins are using different levels for messages displayed. IRC plugin uses following levels:
level 1: message from user (on channel or private)
level 2: nick change (you or someone else)
level 3: any server message (except join/part/quit)
level 4: server message join/part/quit
So if you set level 3 for an IRC channel, WeeChat will log all messages, but not join/part/quit.
Some examples:
set level 3 for IRC channel #weechat:
/set logger.level.irc.freenode.#weechat 3
set level 3 for freenode server buffer:
/set logger.level.irc.server.freenode 3
set level 3 for all channels on server freenode:
/set logger.level.irc.freenode 3
set level 2 for all IRC buffers:
/set logger.level.irc 2
It is possible to define a filename mask for each buffer, and use local buffer variables to build filename. To see local variables for current buffer:
/buffer localvar
For example if you want one directory by IRC server and one file by channel inside:
/set logger.mask.irc "irc/$server/$channel.weechatlog"
You’ll have following files:
~/.weechat/ |--- logs/ |--- irc/ |--- freenode/ | freenode.weechatlog | #weechat.weechatlog | #mychan.weechatlog |--- oftc/ | oftc.weechatlog | #chan1.weechatlog | #chan2.weechatlog
WeeChat provides 5 scripting plugins: Perl, Python, Ruby, Lua and Tcl. These plugins can load, execute and unload scripts for these languages.
For more information about how to write scripts, or WeeChat API for scripts, please read WeeChat Scripting Guide.
You can find some scripts for WeeChat here: http://www.weechat.org/scripts
list/load/unload scripts filename: script (file) to load name: a script name Without argument, this command lists all loaded scripts.
list/load/unload scripts filename: script (file) to load name: a script name Without argument, this command lists all loaded scripts.
list/load/unload scripts filename: script (file) to load name: a script name Without argument, this command lists all loaded scripts.
list/load/unload scripts filename: script (file) to load name: a script name Without argument, this command lists all loaded scripts.
list/load/unload scripts filename: script (file) to load name: a script name Without argument, this command lists all loaded scripts.
Xfer plugin brings:
direct chat (between two hosts, without server): for example "DCC Chat" via IRC plugin
file transfer, for example "DCC" via IRC plugin
xfer.color.status_aborted
description: text color for "aborted" status
type: color
values: a color name (default value: lightred)
xfer.color.status_active
description: text color for "active" status
type: color
values: a color name (default value: lightblue)
xfer.color.status_connecting
description: text color for "connecting" status
type: color
values: a color name (default value: yellow)
xfer.color.status_done
description: text color for "done" status
type: color
values: a color name (default value: lightgreen)
xfer.color.status_failed
description: text color for "failed" status
type: color
values: a color name (default value: lightred)
xfer.color.status_waiting
description: text color for "waiting" status
type: color
values: a color name (default value: lightcyan)
xfer.color.text
description: text color
type: color
values: a color name (default value: default)
xfer.color.text_bg
description: background color
type: color
values: a color name (default value: default)
xfer.color.text_selected
description: text color of selected xfer line
type: color
values: a color name (default value: white)
xfer.file.auto_accept_chats
description: automatically accept chat requests (use carefully!)
type: boolean
values: on, off (default value: off)
xfer.file.auto_accept_files
description: automatically accept incoming files (use carefully!)
type: boolean
values: on, off (default value: off)
xfer.file.auto_rename
description: rename incoming files if already exists (add ".1", ".2", …)
type: boolean
values: on, off (default value: on)
xfer.file.auto_resume
description: automatically resume file transfer if connection with remote host is lost
type: boolean
values: on, off (default value: on)
xfer.file.convert_spaces
description: convert spaces to underscores when sending files
type: boolean
values: on, off (default value: on)
xfer.file.download_path
description: path for writing incoming files
type: string
values: any string (default value: "%h/xfer")
xfer.file.upload_path
description: path for reading files when sending (when no path is specified by user)
type: string
values: any string (default value: "~")
xfer.file.use_nick_in_filename
description: use remote nick as prefix in local filename when receiving a file
type: boolean
values: on, off (default value: on)
xfer.look.auto_open_buffer
description: auto open xfer buffer when a new xfer is added to list
type: boolean
values: on, off (default value: on)
xfer.look.progress_bar_size
description: size of progress bar, in chars (if 0, progress bar is disabled)
type: integer
values: 0 .. 256 (default value: 20)
xfer.network.blocksize
description: block size for sending packets, in bytes
type: integer
values: 1024 .. 102400 (default value: 65536)
xfer.network.fast_send
description: does not wait for ACK when sending file
type: boolean
values: on, off (default value: on)
xfer.network.own_ip
description: IP or DNS address used for sending files/chats (if empty, local interface IP is used)
type: string
values: any string (default value: "")
xfer.network.port_range
description: restricts outgoing files/chats 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, it’s recommended to use ports greater than 1024, because only root can use ports below 1024)
type: string
values: any string (default value: "")
xfer.network.speed_limit
description: speed limit for sending files, in kilo-bytes by second (0 means no limit)
type: integer
values: 0 .. 2147483647 (default value: 0)
xfer.network.timeout
description: timeout for xfer request (in seconds)
type: integer
values: 5 .. 2147483647 (default value: 300)
send a CTCP action to remote host message: message to send
xfer control list: list xfer listfull: list xfer (verbose) Without argument, this command opens buffer with xfer list.
main developer
debian packager
old debian packager
czech translation, patches
polish translation
german translation
russian translation
spanish translation
hungarian translation
italian translation
tcl plugin
patches
SuSE RPM
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!).
Ways to get support:
IRC: server irc.freenode.net, channels #weechat (english) and #weechat-fr (french)
WeeChat forum: http://forums.flashtux.org/
Mailing list:
subscribe: http://mail.nongnu.org/mailman/listinfo/weechat-support
send mail to weechat-support@nongnu.org
archives: http://mail.nongnu.org/archive/html/weechat-support