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

1. Introduction

WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and light, designed for many operating systems.

1.1. Features

Main features are:

  • multi-protocols (IRC, Jabber)

  • multi-servers connection (with SSL, IPv6, proxy)

  • small, fast and light

  • customizable and extensible with plugins and scripts

  • compliant with IRC RFCs 1459, 2810, 2811, 2812 and 2813

  • multi-platform (GNU/Linux, *BSD, MacOS X, Windows and other)

  • 100% GPL, free software

WeeChat homepage is here: http://www.weechat.org/

1.2. Pre-requisites

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

2. Installation

2.1. Binary packages

Binary packages are available for many distributions, including:

  • Debian (or any Debian compatible distribution): apt-get install weechat-curses

  • Mandriva/RedHat (or any RPM compatible distribution): rpm -i /path/to/weechat-x.y.z-1.i386.rpm

  • Gentoo: emerge weechat

  • Arch Linux: pacman -S weechat

  • Fedora Core: yum install weechat

  • Sourcemage: cast weechat

Some additional packages may be useful, like weechat-plugins.

For other distributions, please look at your manual for installation instructions.

2.2. Source package

WeeChat can be compiled with cmake or autotools (cmake is recommended way).

2.2.1. Dependencies

Following table shows list of packages that are required or optional to compile WeeChat.

Package (1) Version Required Feature

cmake

yes

build (autotools still possible, but cmake is recommended)

libncursesw5-dev (2)

yes

ncurses interface

libcurl4-gnutls-dev

yes

URL transfer

gettext

internationalization (translation of messages; base language is english)

libgcrypt11-dev

SASL authentication with IRC server using DH-BLOWFISH mechanism

libgnutls-dev

≥ 2.2.0

SSL connection to IRC server

ca-certificates

certificates for SSL connections

libaspell-dev

aspell plugin

python-dev

≥ 2.5 (3)

python plugin

libperl-dev

perl plugin

ruby1.8-dev

ruby plugin

liblua5.1-0-dev

lua plugin

tcl-dev

≥ 8.5

tcl plugin

guile-1.8-dev

guile (scheme) plugin

asciidoc

≥ 8.5.0

build documentation (HTML files)

source-highlight

syntax highlight for sources in HTML documentation

Note
(1) Name comes from the Debian GNU/Linux distribution, versions and package names may be different in different distributions and versions.
(2) WeeChat can compile with libncurses5-dev, but it is NOT recommended (you will have display bugs with wide chars).
(3) WeeChat can compile with Python 3.x, but recommended Python version is 2.7 (all scripts run fine with version 2.x, but not with version 3.x).

2.2.2. Compile with cmake

  • 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

2.2.3. Compile with autotools

  • 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

2.3. Git sources

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).

2.4. Report crashes

If you experienced crashes, or if you want to report any future WeeChat crash, you have to:

  • compile it with debug info (or install binary package with debug info)

  • enable core files on your system

  • install gdb

2.4.1. Debug info

If you’re compiling with cmake:

$ cmake .. -DCMAKE_BUILD_TYPE=Debug

If you’re compiling with autotools, debug is default (--with-debug=1).

If you installed a binary package, then install package weechat-dbg.

2.4.2. Core files

To enable core files, you have to use ulimit command.

For example under Linux with bash shell, add this line to your ~/.bashrc:

ulimit -c unlimited

Or max size:

ulimit -c 200000

2.4.3. Get backtrace with gdb

When WeeChat crashes, your system will create a file core or core.12345 (12345 is process id). This file is created in directory where you have run WeeChat (this is not directory where WeeChat is installed!).

For example if weechat-curses is installed in /usr/bin/ and core file is in /home/xxx/, then run gdb with this command:

gdb /usr/bin/weechat-curses /home/xxx/core
Note
If you installed binary package weechat-dbg (for example under Debian), then you can use this path for WeeChat binary: /usr/lib/debug/usr/bin/weechat-curses

Then under gdb, use command bt full to display backtrace. You will see something like that:

(gdb) set logging file /tmp/crash.txt
(gdb) set logging on
Copying output to /tmp/crash.txt.
(gdb) bt full
#0  0x00007f9dfb04a465 in raise () from /lib/libc.so.6
#1  0x00007f9dfb04b8e6 in abort () from /lib/libc.so.6
#2  0x0000000000437f66 in weechat_shutdown (return_code=1, crash=1) at /some_path/src/core/weechat.c:351
#3  <signal handler called>
#4  0x000000000044cb24 in hook_process_timer_cb (arg_hook_process=0x254eb90, remaining_calls=<value optimized out>)
    at /some_path/src/core/wee-hook.c:1364
        hook_process = 0x254eb90
        status = <value optimized out>
#5  0x000000000044cc7d in hook_timer_exec () at /some_path/src/core/wee-hook.c:1025
        tv_time = {tv_sec = 1272693881, tv_usec = 212665}
        ptr_hook = 0x2811f40
        next_hook = 0x0
#6  0x000000000041b5b0 in gui_main_loop () at /some_path/src/gui/curses/gui-curses-main.c:319
        hook_fd_keyboard = 0x173b600
        tv_timeout = {tv_sec = 0, tv_usec = 0}
        read_fds = {fds_bits = {0 <repeats 16 times>}}
        write_fds = {fds_bits = {0 <repeats 16 times>}}
        except_fds = {fds_bits = {0 <repeats 16 times>}}
        max_fd = <value optimized out>

You must report this trace to developers, and tell them what action caused this crash.

Thank you for your help!

2.4.4. Debug a running WeeChat

To debug a running WeeChat (for example if WeeChat seems blocked), you can use gdb with process id (replace 12345 with PID of weechat-curses process):

gdb /usr/bin/weechat-curses 12345

Then like for a crash, use command bt full:

(gdb) bt full

3. Usage

3.1. Running WeeChat

Command line arguments:

-a, --no-connect

Disable auto-connect to servers when WeeChat is starting

-c, --colors

Display default colors in terminal

-d, --dir path

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)

-h, --help

Display help

-k, --keys

Display WeeChat default keys

-l, --license

Display WeeChat license

-p, --no-plugin

Disable plugins auto-load

-s, --no-script

Disable scripts auto-load

-v, --version

Display WeeChat version

plugin:option

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).

3.2. Screen layout

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] [6] [irc/freenode] 3:#test(+n){5}* [Act: 4:#abc(2,5), 6]                         │
│[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

 [6]                   

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 (with channel modes for irc channels)

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:#abc(2,5), 6] 

list of buffers with activity (unread messages) (in example, 2 highlights and 5 unread messages on #abc, one unread message on buffer #6)

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

 [flashy]                                   

input prompt (nick for irc plugin)

away

 (away)                                     

away indicator

input_search

 [Text search]                              

text search indicator

input_text

 hi joe!                                    

input text

3.3. Default key bindings

3.3.1. Keys for command line

Key Description Command

Go to previous char in command line

 /input move_previous_char

Ctrl+b

Go to next char in command line

 /input move_next_char

Ctrl+f

Ctrl+

Go to previous word in command line

 /input move_previous_word

Alt+b

Ctrl+

Go to next word in command line

 /input move_next_word

Alt+f

Home

Go to the beginning of command line

 /input move_beginning_of_line

Ctrl+a

End

Go to the end of command line

 /input move_end_of_line

Ctrl+e

Ctrl+c , b

Insert code for bold text

 /input insert \x02

Ctrl+c , c

Insert code for colored text

 /input insert \x03

Ctrl+c , i

Insert code for italic text

 /input insert \x1D

Ctrl+c , o

Insert code for color reset

 /input insert \x0F

Ctrl+c , r

Insert code for reverse color

 /input insert \x12

Ctrl+c , u

Insert code for underlined text

 /input insert \x15

Del

Delete next char in command line

 /input delete_next_char

Ctrl+d

Backsp.

Delete previous char in command line

 /input delete_previous_char

Ctrl+h

Ctrl+k

Delete from cursor until end of command line (deleted string is copied to clipboard)

 /input delete_end_of_line

Ctrl+r

Search for text in buffer history (see keys for search context)

 /input search_text

Ctrl+t

Transpose chars

 /input transpose_chars

Ctrl+u

Delete from cursor until beginning of command line (deleted string is copied to clipboard)

 /input delete_beginning_of_line

Ctrl+w

Delete previous word of command line (deleted string is copied to clipboard)

 /input delete_previous_word

Ctrl+y

Paste clipboard content

 /input clipboard_paste

Ctrl+_

Undo last action on command line

 /input undo

Alt+_

Redo last action on command line

 /input redo

Tab

Complete command or nick (Tab again: find next completion)

 /input complete_next

Shift+Tab

Without completion: do a partial completion, with pending completion: complete with previous completion

 /input complete_previous

Enter

Execute command or send message (in search mode: stop search)

 /input return

Ctrl+j

Ctrl+m

Call previous command/message (in search mode: search up)

 /input history_previous

Call next command/message (in search mode: search down)

 /input history_next

Ctrl+

Call previous command/message in global history (common for all buffers)

 /input history_global_previous

Ctrl+

Call next command/message in global history (common for all buffers)

 /input history_global_next

Alt+d

Delete next word in command line (deleted string is copied to clipboard)

 /input delete_next_word

Alt+k

Grab a key and insert its code (and command bound if key exists) in command line

 /input grab_key_command

Alt+r

Delete entire command line

 /input delete_line

3.3.2. Keys for buffers / windows

Key Description Command

Ctrl+l (L)

Redraw whole window

 /window refresh

Ctrl+s , Ctrl+u

Set unread marker on all buffers

 /input set_unread

Ctrl+x

Switch current buffer if buffers are attached with same number

 /input switch_active_buffer

PgUp

Scroll up one page in buffer history

 /window page_up

PgDn

Scroll down one page in buffer history

 /window page_down

Alt+PgUp

Scroll up a few lines in buffer history

 /window scroll_up

Alt+PgDn

Scroll down a few lines in buffer history

 /window scroll_down

Alt+Home

Scroll to top of buffer

 /window scroll_top

Alt+End

Scroll to bottom of buffer

 /window scroll_bottom

Alt+

Switch to previous buffer

 /buffer -1

Alt+

Ctrl+p

F5

Alt+

Switch to next buffer

 /buffer +1

Alt+

Ctrl+n

F6

F7

Switch to previous window

 /window -1

F8

Switch to next window

 /window +1

F9

Scroll buffer’s title on the left

 /bar scroll title * -30%

F10

Scroll buffer’s title on the right

 /bar scroll title * +30%

F11

Scroll up one page in nicklist

 /bar scroll nicklist * -100%

F12

Scroll down one page in nicklist

 /bar scroll nicklist * +100%

Alt+F11

Go to the beginning of nicklist

 /bar scroll nicklist * b

Alt+F12

Go to the end of nicklist

 /bar scroll nicklist * e

Alt+a

Switch to next buffer with activity (with priority: highlight, message, other)

 /input jump_smart

Alt+h

Clear hotlist (activity notification on other buffers)

 /input hotlist_clear

Alt+j , Alt+l (L)

Switch to last buffer

 /input jump_last_buffer

Alt+j , Alt+r

Switch to IRC raw buffer

 /server raw

Alt+j , Alt+s

Switch to IRC server buffer

 /server jump

Alt+0…9

Switch to buffer by number (0 = 10)

 /buffer *N

Alt+j , 01…99

Switch to buffer by number

 /buffer NN

Alt+m

Toggle mouse

 /mouse toggle

Alt+n

Scroll to next highlight

 /window scroll_next_highlight

Alt+p

Scroll to previous highlight

 /window scroll_previous_highlight

Alt+u

Scroll to first unread line in buffer

 /window scroll_unread

Alt+w , Alt+

Switch to window above

 /window up

Alt+w , Alt+

Switch to window below

 /window down

Alt+w , Alt+

Switch to window on the left

 /window left

Alt+w , Alt+

Switch to window on the right

 /window right

Alt+w , Alt+b

Balance the sizes of all windows

 /window balance

Alt+w , Alt+s

Swap buffers of two windows

 /window swap

Alt+z

Zoom on current window (Alt+z again: restore initial windows state, before zoom)

 /window zoom

Alt+<

Switch to previous buffer in list of visited buffers

 /input jump_previously_visited_buffer

Alt+>

Switch to next buffer in list of visited buffers

 /input jump_next_visited_buffer

Alt+/

Switch to last buffer displayed (before last jump to a buffer)

 /input jump_last_buffer_displayed

Alt+=

Toggle filters on/off

 /filter toggle

3.3.3. Keys for "search" context

These keys are used in context "search" (when Ctrl+r is pressed to search text in buffer).

Key Description Command

Ctrl+r

Switch exact case for search

 /input search_switch_case

Search previous line

 /input search_previous

Search next line

 /input search_next

Enter

Stop search

 /input search_stop

Ctrl+j

Ctrl+m

3.3.4. Keys for "cursor" context

These keys are used in context "cursor" (free movement of cursor on screen).

Key Area Description Command

-

Move cursor one line up

 /cursor move up

-

Move cursor one line down

 /cursor move down

-

Move cursor one column left

 /cursor move left

-

Move cursor one column right

 /cursor move right

Alt+

-

Move cursor one area up

 /cursor move area_up

Alt+

-

Move cursor one area down

 /cursor move area_down

Alt+

-

Move cursor one area left

 /cursor move area_left

Alt+

-

Move cursor one area right

 /cursor move area_right

m

chat

Quote message

 hsignal:chat_quote_message;/cursor stop

q

chat

Quote prefix + message

 hsignal:chat_quote_prefix_message;/cursor stop

Q

chat

Quote time + prefix + message

 hsignal:chat_quote_time_prefix_message;/cursor stop

b

nicklist

Ban nick

 /window ${_window_number};/ban ${nick}

k

nicklist

Kick nick

 /window ${_window_number};/kick ${nick}

K

nicklist

Kick and ban nick

 /window ${_window_number};/kickban ${nick}

q

nicklist

Open query with nick

 /window ${_window_number};/query ${nick};/cursor stop

w

nicklist

Do a whois on nick

 /window ${_window_number};/whois ${nick}

Enter

-

Stop cursor mode

 /cursor stop

Ctrl+j

Ctrl+m

3.3.5. Keys for "mouse" context

These keys are used in context "mouse", namely when a mouse event occurs.

Button Gesture Area Description Command

◾◽◽

-

chat

Switch to window

 /window ${_window_number}

◾◽◽

left

chat

Switch to previous buffer

 /window ${_window_number};/buffer +1

◾◽◽

right

chat

Switch to next buffer

 /window ${_window_number};/buffer +1

◾◽◽

left (long)

chat

Switch to first buffer

 /window ${_window_number};/buffer 1

◾◽◽

right (long)

chat

Switch to last buffer

 /window ${_window_number};/input jump_last_buffer

wheel ⇑

-

chat

Scroll up a few lines in buffer history

 /window scroll_up -window ${_window_number}

wheel ⇓

-

chat

Scroll down a few lines in buffer history

 /window scroll_down -window ${_window_number}

◾◽◽

up

nicklist

Scroll up one page in nicklist

 /bar scroll nicklist ${_window_number} -100%

◾◽◽

down

nicklist

Scroll down one page in nicklist

 /bar scroll nicklist ${_window_number} +100%

◾◽◽

up (long)

nicklist

Go to the beginning of nicklist

 /bar scroll nicklist ${_window_number} b

◾◽◽

down (long)

nicklist

Go to the end of nicklist

 /bar scroll nicklist ${_window_number} e

◾◽◽

-

nicklist

Open query with nick

 /window ${_window_number};/query ${nick}

◽◽◾

-

nicklist

Do a whois on nick

 /window ${_window_number};/whois ${nick}

◾◽◽

left

nicklist

Kick nick

 /window ${_window_number};/kick ${nick}

◾◽◽

left (long)

nicklist

Kick and ban nick

 /window ${_window_number};/kickban ${nick}

◽◽◾

left

nicklist

Ban nick

 /window ${_window_number};/ban ${nick}

◽◽◾

-

input

Grab a mouse event and insert its code in command line

 /input grab_mouse_area

wheel ⇑

-

any bar

Scroll bar by -10%

 /bar scroll ${_bar_name} ${_window_number} -20%

wheel ⇓

-

any bar

Scroll bar by +10%

 /bar scroll ${_bar_name} ${_window_number} +20%

◽◾◽

-

anywhere

Start cursor mode at this point

 /cursor go ${_x},${_y}

3.4. Mouse support

WeeChat supports mouse clicks and gestures. It is working with local terminal, and remotely via ssh connection with or without screen/tmux.

3.4.1. Enable mouse

To enable mouse at startup:

/set weechat.look.mouse on

To enable mouse now, press Alt+m or do following command:

/mouse enable

It is possible to temporarily disable mouse, and bind that on a key. For example key Alt+x to disable mouse for 10 seconds:

/key bind meta-x /mouse toggle 10

When mouse is enabled in WeeChat, you can use "shift" modifier to select or click in terminal, as if the mouse was disabled (on some terminals like iTerm, you have to use "alt" instead of "shift").

Note
For any problem with mouse, please look at WeeChat FAQ.

3.4.2. Bind mouse events to commands

Many default mouse events are already defined by WeeChat (see keys for "mouse" context).

You can change or add bindings with the command /key using context "mouse" (for syntax, see command /key).

Event name consists of a modifier (optional), a button/wheel name and a gesture (optional). Different elements are separated by "-".

List of modifiers:

Modifier Description

ctrl

key Ctrl

alt

key Alt

ctrl-alt

keys Ctrl and Alt

List of buttons/wheel:

Button/wheel Description

button1

click on left button

button2

click on right button

button3

click on middle button (often click on wheel)

button4 … button9

click on extra buttons

wheelup

wheel (up)

wheeldown

wheel (down)

List of gestures (only for buttons, not wheel):

Gesture Distance

gesture-up

3 … 19

gesture-up-long

≥ 20

gesture-down

3 … 19

gesture-down-long

≥ 20

gesture-left

3 … 39

gesture-left-long

≥ 40

gesture-right

3 … 39

gesture-right-long

≥ 40

Example of events:

  • button1

  • ctrl-button1

  • button1-gesture-right

  • alt-button2-gesture-down-long

  • wheelup

  • ctrl-alt-wheeldown

Tip
When binding a key in context "mouse", it’s possible to match many events using * at beginning or end of name, for example button1-gesture-* will match any gesture made using left button.
Tip
You can find an event name with command /input grab_mouse then doing event with mouse. This will insert event name on command line.

3.5. Command line

WeeChat command line (at the bottom of window) lets you execute commands or send text to buffer.

3.5.1. Syntax

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

3.5.2. Color codes

For some plugins like IRC, you can use color codes and attributes, as follow (press Ctrl+c then following letter, with optional value):

Ctrl+c , b

bold text

Ctrl+c , c , xx

text color xx (see list of colors below)

Ctrl+c , c , xx,yy

text color xx and background yy (see list of colors below)

Ctrl+c , o

disable color and attributes

Ctrl+c , r

reverse video (revert text color with background)

Ctrl+c , u

underlined text

Note
The same code (without number for Ctrl+c , c) may be used to stop the attribute.

Color codes for Ctrl+c , c are:

Code IRC WeeChat (curses)

00

white

white

01

black

black

02

dark blue

blue

03

dark green

green

04

light red

lightred

05

dark red

red

06

magenta

magenta

07

orange

brown

08

yellow

yellow

09

light green

lightgreen

10

cyan

cyan

11

light cyan

lightcyan

12

light blue

lightblue

13

light magenta

lightmagenta

14

gray

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^Cueverybody^Cu^Cc!
Note
In irc plugin, you can remap these colors using option irc.color.mirc_remap.

3.6. Colors

WeeChat can use up to 256 color pairs to display text in bars and chat area (your terminal must support 256 colors to use them in WeeChat).

According to value of TERM environment variable, you may have following limits for colors in WeeChat:

$TERM Colors Pairs (1)

"rxvt-unicode", "xterm",…

88

256

"rxvt-256color", "xterm-256color",…

256

32767

"screen"

8

64

"screen-256color"

256

32767

Note
(1) Even if your terminal supports more than 256 pairs, only 256 pairs can be used in WeeChat, because of a ncurses limitation.

You can run weechat-curses --colors or use command /color in WeeChat to display limits for your environment.

Some recommended values for TERM if you want 256 colors:

  • under screen: screen-256color

  • outside screen: xterm-256color, rxvt-256color, putty-256color,…

Note
You may have to install package "ncurses-term" to use these values in TERM variable.

If you are using screen, you can add this line to your ~/.screenrc:

term screen-256color

If your TERM variable has wrong value and that WeeChat is already running, don’t panic! You can change it without restarting, thanks to script shell.py:

/shell setenv TERM=screen-256color
/upgrade

3.6.1. Basic colors

Basic colors in WeeChat are:

Name Color

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

gray

gray

white

white

3.6.2. Extended colors

WeeChat dynamically allocates color pairs when colors are used on screen (to display buffers and bars).

In addition to basic colors, you can use a color number between 1 and the limit of your terminal.

Use command /color to see current colors and limits. With Alt+c you can temporarily switch to terminal colors to choose a color.

For example if you want to display time in orange in buffer, do:

/set weechat.color.chat_time 214

Or if you want a very dark green background for status bar:

/set weechat.bar.status.color_bg 22

3.6.3. Aliases

You can add color aliases with command /color alias and then use this alias in any color option.

For example:

/color alias 214 orange
/set weechat.color.chat_delimiters orange

3.6.4. Attributes

It is possible to use some attributes for colors. One or more attributes can be added before color name or number:

  • * : bold text

  • ! : reverse video

  • _ : underlined text

  • | : keep attributes: do not reset bold/reverse/underlined when changing color

For example if you want self nick as white underlined, do:

/set weechat.color.chat_nick_self _white

Or if you want time in status bar as orange underlined with bold:

/set weechat.color.status_time *_214

To use an attribute with default terminal color (-1), you must use a number greater than last terminal color, for example max color in WeeChat: 99999.

Example of bold with terminal foreground color:

/set weechat.color.status_time *99999

3.7. WeeChat options (weechat.conf)

  • weechat.color.bar_more

    • description: text color for '+' when scrolling bars

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightmagenta)

  • weechat.color.chat

    • description: text color for chat

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.color.chat_bg

    • description: background color for chat

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.color.chat_buffer

    • description: text color for buffer names

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: white)

  • weechat.color.chat_channel

    • description: text color for channel names

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: white)

  • weechat.color.chat_delimiters

    • description: text color for delimiters

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • weechat.color.chat_highlight

    • description: text color for highlighted prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • weechat.color.chat_highlight_bg

    • description: background color for highlighted prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: magenta)

  • weechat.color.chat_host

    • description: text color for hostnames

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: cyan)

  • weechat.color.chat_inactive_buffer

    • description: text color for chat when line is inactive (buffer is merged with other buffers and is not selected)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: darkgray)

  • weechat.color.chat_inactive_window

    • description: text color for chat when window is inactive (not current selected window)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: darkgray)

  • weechat.color.chat_nick

    • description: text color for nicks in chat window

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightcyan)

  • weechat.color.chat_nick_colors

    • description: text color for nicks (comma separated list of colors, background is allowed with format: "fg:bg", for example: "lightred:blue")

    • type: string

    • values: any string (default value: "cyan,magenta,green,brown,lightblue,default,lightcyan,lightmagenta,lightgreen,blue")

  • weechat.color.chat_nick_other

    • description: text color for other nick in private buffer

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: cyan)

  • weechat.color.chat_nick_self

    • description: text color for local nick in chat window

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: white)

  • weechat.color.chat_prefix_action

    • description: text color for action prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (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 WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: brown)

  • weechat.color.chat_prefix_buffer_inactive_buffer

    • description: text color for inactive buffer name (before prefix, when many buffers are merged with same number and if buffer is not selected)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: darkgray)

  • weechat.color.chat_prefix_error

    • description: text color for error prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • weechat.color.chat_prefix_join

    • description: text color for join prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightgreen)

  • weechat.color.chat_prefix_more

    • description: text color for '+' when prefix is too long

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightmagenta)

  • weechat.color.chat_prefix_network

    • description: text color for network prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: magenta)

  • weechat.color.chat_prefix_quit

    • description: text color for quit prefix

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightred)

  • weechat.color.chat_prefix_suffix

    • description: text color for suffix (after prefix)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • weechat.color.chat_read_marker

    • description: text color for unread data marker

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: magenta)

  • weechat.color.chat_read_marker_bg

    • description: background color for unread data marker

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.color.chat_server

    • description: text color for server names

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: brown)

  • weechat.color.chat_tags

    • description: text color for tags after messages (displayed with command /debug tags)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: red)

  • weechat.color.chat_text_found

    • description: text color for marker on lines where text sought is found

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (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 WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightmagenta)

  • weechat.color.chat_time

    • description: text color for time in chat window

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.color.chat_time_delimiters

    • description: text color for time delimiters

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: brown)

  • weechat.color.chat_value

    • description: text color for values

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: cyan)

  • weechat.color.input_actions

    • description: text color for actions in input line

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightgreen)

  • weechat.color.input_text_not_found

    • description: text color for unsuccessful text search in input line

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: red)

  • weechat.color.nicklist_away

    • description: text color for away nicknames

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: cyan)

  • weechat.color.nicklist_group

    • description: text color for groups in nicklist

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • weechat.color.nicklist_offline

    • description: text color for offline nicknames

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: blue)

  • weechat.color.separator

    • description: background color for window separators (when split)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: blue)

  • weechat.color.status_count_highlight

    • description: text color for count of highlight messages in hotlist (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: magenta)

  • weechat.color.status_count_msg

    • description: text color for count of messages in hotlist (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: brown)

  • weechat.color.status_count_other

    • description: text color for count of other messages in hotlist (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.color.status_count_private

    • description: text color for count of private messages in hotlist (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • weechat.color.status_data_highlight

    • description: text color for buffer with highlight (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightmagenta)

  • weechat.color.status_data_msg

    • description: text color for buffer with new messages (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • weechat.color.status_data_other

    • description: text color for buffer with new data (not messages) (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.color.status_data_private

    • description: text color for buffer with private message (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightgreen)

  • weechat.color.status_filter

    • description: text color for filter indicator in status bar

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • weechat.color.status_more

    • description: text color for buffer with new data (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • weechat.color.status_name

    • description: text color for current buffer name in status bar

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: white)

  • weechat.color.status_name_ssl

    • description: text color for current buffer name in status bar, if data are secured with a protocol like SSL

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightgreen)

  • weechat.color.status_number

    • description: text color for current buffer number in status bar

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • weechat.color.status_time

    • description: text color for time (status bar)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • weechat.completion.base_word_until_cursor

    • description: if enabled, the base word to complete ends at char before cursor; otherwise the base word ends at first space after cursor

    • type: boolean

    • values: on, off (default value: on)

  • 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_buffer_lines_minutes

    • description: maximum number of minutes in history per buffer (0 = unlimited, examples: 1440 = one day, 10080 = one week, 43200 = one month, 525600 = one year)

    • type: integer

    • values: 0 .. 2147483647 (default value: 0)

  • weechat.history.max_buffer_lines_number

    • description: maximum number of lines in history per buffer (0 = unlimited)

    • type: integer

    • values: 0 .. 2147483647 (default value: 4096)

  • 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_visited_buffers

    • description: maximum number of visited buffers to keep in memory

    • type: integer

    • values: 0 .. 1000 (default value: 50)

  • weechat.look.align_end_of_lines

    • description: alignment for end of lines (all lines after the first): they are starting under this data (time, buffer, prefix, suffix, message (default))

    • type: integer

    • values: time, buffer, prefix, suffix, message (default value: message)

  • weechat.look.bar_more_down

    • description: string displayed when bar can be scrolled down (for bars with filling different from "horizontal")

    • type: string

    • values: any string (default value: "++")

  • weechat.look.bar_more_left

    • description: string displayed when bar can be scrolled to the left (for bars with filling "horizontal")

    • type: string

    • values: any string (default value: "<<")

  • weechat.look.bar_more_right

    • description: string displayed when bar can be scrolled to the right (for bars with filling "horizontal")

    • type: string

    • values: any string (default value: ">>")

  • weechat.look.bar_more_up

    • description: string displayed when bar can be scrolled up (for bars with filling different from "horizontal")

    • type: string

    • values: any string (default value: "--")

  • 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): all=all messages (default), message=messages+highlights, highlight=highlights only, none=never display in hotlist

    • type: integer

    • values: none, highlight, message, all (default value: all)

  • weechat.look.buffer_time_format

    • description: time format for each line displayed in buffers (see man strftime for date/time specifiers), colors are allowed with format "${color}", for example french time: "${lightblue}%H${white}%M${lightred}%S"

    • type: string

    • values: any string (default value: "%H:%M:%S")

  • weechat.look.color_basic_force_bold

    • description: force "bold" attribute for light colors and "darkgray" in basic colors (this option is disabled by default: bold is used only if terminal has less than 16 colors)

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.color_inactive_buffer

    • description: use a different color for lines in inactive buffer (when line is from a merged buffer not selected)

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.color_inactive_message

    • description: use a different color for inactive message (when window is not current window, or if line is from a merged buffer not selected)

    • type: boolean

    • values: on, off (default value: on)

  • weechat.look.color_inactive_prefix

    • description: use a different color for inactive prefix (when window is not current window, or if line is from a merged buffer not selected)

    • type: boolean

    • values: on, off (default value: on)

  • weechat.look.color_inactive_prefix_buffer

    • description: use a different color for inactive buffer name in prefix (when window is not current window, or if line is from a merged buffer not selected)

    • type: boolean

    • values: on, off (default value: on)

  • weechat.look.color_inactive_time

    • description: use a different color for inactive time (when window is not current window, or if line is from a merged buffer not selected)

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.color_inactive_window

    • description: use a different color for lines in inactive window (when window is not current window)

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.color_pairs_auto_reset

    • description: automatically reset table of color pairs when number of available pairs is lower or equal to this number (-1 = disable automatic reset, and then a manual "/color reset" is needed when table is full)

    • type: integer

    • values: -1 .. 256 (default value: 5)

  • 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.command_chars

    • description: chars used to determine if input string is a command or not: input must start with one of these chars; the slash ("/") is always considered as command prefix (example: ".$")

    • type: string

    • values: any string (default value: "")

  • weechat.look.confirm_quit

    • description: if set, /quit command must be confirmed with extra argument "-yes" (see /help quit)

    • 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.eat_newline_glitch

    • description: if set, the eat_newline_glitch will be set to 0; this is used to not add new line char at end of each line, and then not break text when you copy/paste text from WeeChat to another application (this option is disabled by default because it can cause serious display bugs)

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.highlight

    • description: comma separated list of words to highlight; case insensitive comparison (use "(?-i)" at beginning of words to make them case sensitive), words may begin or end with "*" for partial match; example: "test,(?-i)*toto*,flash*"

    • type: string

    • values: any string (default value: "")

  • weechat.look.highlight_regex

    • description: regular expression used to check if a message has highlight or not, at least one match in string must be surrounded by word chars (alphanumeric, "-", "_" or "|"), regular expression is case insensitive (use "(?-i)" at beginning to make it case sensitive), examples: "flashcode|flashy", "(?-i)FlashCode|flashy"

    • type: string

    • values: any string (default value: "")

  • weechat.look.highlight_tags

    • description: comma separated list of tags to highlight (case insensitive comparison, examples: "irc_notice" for IRC notices, "nick_flashcode" for messages from nick "FlashCode")

    • type: string

    • values: any string (default value: "")

  • weechat.look.hotlist_add_buffer_if_away

    • description: add any buffer to hotlist (including current or visible buffers) if local variable "away" is set on buffer

    • type: boolean

    • values: on, off (default value: on)

  • weechat.look.hotlist_buffer_separator

    • description: string displayed between buffers in hotlist

    • type: string

    • values: any string (default value: ", ")

  • weechat.look.hotlist_count_max

    • description: max number of messages count to display in hotlist for a buffer (0 = never display messages count)

    • type: integer

    • values: 0 .. 4 (default value: 2)

  • weechat.look.hotlist_count_min_msg

    • description: display messages count if number of messages is greater or equal to this value

    • type: integer

    • values: 1 .. 100 (default value: 2)

  • 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.hotlist_unique_numbers

    • description: keep only unique numbers in hotlist (this applies only on hotlist items where name is NOT displayed after number)

    • type: boolean

    • values: on, off (default value: on)

  • weechat.look.input_cursor_scroll

    • description: number of chars displayed after end of input line when scrolling to display end of line

    • type: integer

    • values: 0 .. 100 (default value: 20)

  • weechat.look.input_share

    • description: share commands, text, or both in input for all buffers (there is still local history for each buffer)

    • type: integer

    • values: none, commands, text, all (default value: none)

  • weechat.look.input_share_overwrite

    • description: if set and input is shared, always overwrite input in target buffer

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.input_undo_max

    • description: max number of "undo" for command line, by buffer (0 = undo disabled)

    • type: integer

    • values: 0 .. 65535 (default value: 32)

  • weechat.look.item_buffer_filter

    • description: string used to show that some lines are filtered in current buffer (bar item "buffer_filter")

    • type: string

    • values: any string (default value: "*")

  • weechat.look.item_time_format

    • description: time format for "time" bar item (see man strftime for date/time specifiers)

    • 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.mouse

    • description: enable mouse support

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.mouse_timer_delay

    • description: delay (in milliseconds) to grab a mouse event: WeeChat will wait this delay before processing event

    • type: integer

    • values: 1 .. 10000 (default value: 100)

  • 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_min

    • description: min size for prefix

    • 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, char (default value: line)

  • weechat.look.read_marker_always_show

    • description: always show read marker, even if it is after last buffer line

    • type: boolean

    • values: on, off (default value: off)

  • weechat.look.read_marker_string

    • description: string used to draw read marker line (string is repeated until end of line)

    • type: string

    • values: any string (default value: "- ")

  • 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_bottom_after_switch

    • description: scroll to bottom of window after switch to another buffer (do not remember scroll position in windows); the scroll is done only for buffers with formatted content (not free content)

    • type: boolean

    • values: on, off (default value: off)

  • 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.separator_horizontal

    • description: char used to draw horizontal separators around bars (empty value will draw a real line with ncurses, but may cause bugs with URL selection under some terminals), wide chars are NOT allowed here

    • type: string

    • values: any string (default value: "-")

  • weechat.look.separator_vertical

    • description: char used to draw vertical separators around bars (empty value will draw a real line with ncurses), wide chars are NOT allowed here

    • type: string

    • values: any string (default value: "")

  • 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.look.time_format

    • description: time format for dates converted to strings and displayed in messages

    • type: string

    • values: any string (default value: "%a, %d %b %Y %T")

  • weechat.network.gnutls_ca_file

    • description: file containing the certificate authorities ("%h" will be replaced by WeeChat home, "~/.weechat" by default)

    • type: string

    • values: any string (default value: "/etc/ssl/certs/ca-certificates.crt")

  • weechat.network.gnutls_handshake_timeout

    • description: timeout (in seconds) for gnutls handshake

    • type: integer

    • values: 1 .. 2147483647 (default value: 30)

  • weechat.plugin.autoload

    • description: comma separated list of plugins to load automatically at startup, "*" means all plugins found, a name beginning with "!" is a negative value to prevent a plugin from being loaded, names can start or end with "*" to match several plugins (examples: "*" or "*,!lua,!tcl")

    • 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: comma separated list of file name extensions for plugins

    • type: string

    • values: any string (default value: ".so,.dll")

  • 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)

3.8. WeeChat commands

away toggle away status
/away  [-all] [<message>]

   -all: toggle away status on all connected servers
message: message for away (if no message is given, away status is removed)
bar manage bars
/bar  list|listfull|listitems
      add <name> <type>[,<cond1>[,<cond2>...]] <position> <size> <separator> <item1>[,<item2>...]
      default [input|title|status|nicklist]
      del <name>|-all
      set <name> <option> <value>
      hide|show|toggle <name>
      scroll <name> <window> <scroll_value>

         list: list all bars
     listfull: list all bars (verbose)
    listitems: list all bar items
          add: add a new bar
         name: 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 a default bar (all default bars if no bar name is given)
          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
       window: window number (use '*' for current window or for root bars)
 scroll_value: value for scroll: 'x' or 'y' (optional), followed by '+', '-', 'b' (beginning) or 'e' (end), value (for +/-), and optional % (to scroll by % of width/height, otherwise value is number of chars)

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 to end of nicklist on current buffer:
    /bar scroll nicklist * ye
buffer manage buffers
/buffer  list
         clear [<number>|<name>|-merged|-all]
         move|merge <number>
         unmerge [<number>|-all]
         close [<n1>[-<n2>]|<name>]
         notify <level>
         localvar
         set <property> <value>
         get <property>
         <number>|<name>

    list: list buffers (without argument, this list is displayed)
   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 or name is optional)
  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
     get: display a property of 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
  move buffer to number 5:
    /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
color define color aliases and display palette of colors
/color  alias <color> <name>
        unalias <color>
        reset

  alias: add an alias for a color
unalias: delete an alias
  color: color number (greater than or equal to 0, max depends on terminal, commonly 63 or 255)
   name: alias name for color (for example: "orange")
  reset: reset all color pairs (required when no more color pairs are available if automatic reset is disabled, see option weechat.look.color_pairs_auto_reset)

Without argument, this command displays colors in a new buffer.

Examples:
  add alias "orange" for color 214:
    /color alias 214 orange
  delete color 214:
    /color unalias 214
command launch explicit WeeChat or plugin command
/command  <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)
cursor free movement of cursor on screen to execute actions on specific areas of screen
/cursor  go chat|<bar>|<x>,<y>
         move up|down|left|right|area_up|area_down|area_left|area_right
         stop

  go: move cursor to chat area, a bar (using bar name) or coordinates "x,y"
move: move cursor with direction
stop: stop cursor mode

Without argument, this command toggles cursor mode.

When mouse is enabled (see /help mouse), by default a middle click will start cursor mode at this point.

Examples:
  go to nicklist:
    /cursor go nicklist
  go to coordinates x=10, y=5:
    /cursor go 10,5
debug control debug for core/plugins
/debug  list
        set <plugin> <level>
        dump [<plugin>]
        buffer|color|infolists|memory|tags|term|windows
        mouse|cursor [verbose]
        hdata [free]

     list: list plugins with debug levels
      set: set debug 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
    color: display infos about current color pairs
   cursor: toggle debug for cursor mode
    hdata: display infos about hdata (with free: remove all hdata in memory)
    hooks: display infos about hooks
infolists: display infos about infolists
   memory: display infos about memory usage
    mouse: toggle debug for mouse
     tags: display tags for lines
     term: display infos about terminal
  windows: display windows tree
filter filter messages in buffers, to hide/show them according to tags or regex
/filter  list
         enable|disable|toggle [<name>]
         add <name> <buffer>[,<buffer>...] <tags> <regex>
         del <name>|-all

   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
 buffer: comma separated list of buffers where filter is active:
         - this is full name including plugin (example: "irc.freenode.#weechat")
         - "*" means all buffers
         - a name starting with '!' is excluded
         - name can start or end with '*' to match many 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: '\|'
         - if regex starts with '!', then matching result is reversed (use '\!' to start with '!')
         - two regular expressions are created: one for prefix and one for message
         - regex are case insensitive, they can start by "(?-i)" to become case sensitive

The default key alt+'=' toggles filtering on/off.

Tags most commonly used:
  no_filter, no_highlight, no_log, log0..log9 (log level),
  notify_none, notify_message, notify_private, notify_highlight,
  nick_xxx (xxx is nick in message),
  irc_xxx (xxx is command name or number, see /server raw),
  irc_numeric, irc_error, irc_action, irc_ctcp, irc_ctcp_reply, irc_smart_filter, away_info.
To see tags for lines in buffers: /debug tags

Examples:
  use IRC smart filter on all buffers:
    /filter add irc_smart * irc_smart_filter *
  use IRC smart filter on all buffers except those with "#weechat" in name:
    /filter add irc_smart *,!*#weechat* irc_smart_filter *
  filter all IRC join/part/quit messages:
    /filter add joinquit * irc_join,irc_part,irc_quit *
  filter nicks displayed when joining channels or with /names:
    /filter add nicks * irc_366 *
  filter nick "toto" on IRC channel #weechat:
    /filter add toto irc.freenode.#weechat nick_toto *
  filter lines containing "weechat sucks" on IRC channel #weechat:
    /filter add sucks irc.freenode.#weechat * weechat sucks
help display help about commands and options
/help  -list|-listfull [<plugin> [<plugin>...]]
       <command>
       <option>

    -list: list commands, by plugin (without argument, this list is displayed)
-listfull: list commands with description, by plugin
   plugin: list commands for this plugin
  command: a command name
   option: an option name (use /set to see list)
history show buffer command history
/history  clear
          <value>

clear: clear history
value: number of history entries to show
input functions for command line
/input  <action> [<arguments>]

list of actions:
  return: simulate key "enter"
  complete_next: complete word with next completion
  complete_previous: complete word with previous completion
  search_text: search text in buffer
  search_switch_case: switch exact case for search
  search_previous: search previous line
  search_next: search next line
  search_stop: stop search
  delete_previous_char: delete previous char
  delete_next_char: delete next char
  delete_previous_word: delete previous word
  delete_next_word: delete next word
  delete_beginning_of_line: delete from beginning of line until cursor
  delete_end_of_line: delete from cursor until end of line
  delete_line: delete entire line
  clipboard_paste: paste from clipboard
  transpose_chars: transpose two chars
  undo: undo last command line action
  redo: redo last command line action
  move_beginning_of_line: move cursor to beginning of line
  move_end_of_line: move cursor to end of line
  move_previous_char: move cursor to previous char
  move_next_char: move cursor to next char
  move_previous_word: move cursor to previous word
  move_next_word: move cursor to next word
  history_previous: recall previous command in current buffer history
  history_next: recall next command in current buffer history
  history_global_previous: recall previous command in global history
  history_global_next: recall next command in global history
  jump_smart: jump to next buffer with activity
  jump_last_buffer: jump to last buffer
  jump_last_buffer_displayed: jump to last buffer displayed (before last jump to a buffer)
  jump_previously_visited_buffer: jump to previously visited buffer
  jump_next_visited_buffer: jump to next visited buffer
  hotlist_clear: clear hotlist
  grab_key: grab a key (optional argument: delay for end of grab, default is 500 milliseconds)
  grab_key_command: grab a key with its associated command (optional argument: delay for end of grab, default is 500 milliseconds)
  grab_mouse: grab mouse event code
  grab_mouse_area: grab mouse event code with area
  set_unread: set unread marker for all buffers
  set_unread_current_buffer: set unread marker for current buffer
  switch_active_buffer: switch to next merged buffer
  switch_active_buffer_previous: switch to previous merged buffer
  insert: insert text in command line

This command is used by key bindings or plugins.
key bind/unbind keys
/key  list|listdefault|listdiff [<context>]
      bind <key> [<command> [<args>]]
      bindctxt <context> <key> [<command> [<args>]]
      unbind <key>
      unbindctxt <context> <key>
      reset <key>
      resetctxt <context> <key>
      resetall -yes [<context>]
      missing [<context>]

       list: list all current keys (without argument, this list is displayed)
listdefault: list default keys
   listdiff: list differences between current and default keys (keys added, redefined or deleted)
    context: name of context ("default" or "search")
       bind: bind a command to a key or display command bound to key (for context "default")
   bindctxt: bind a command to a key or display command bound to key, for given context
     unbind: remove a key binding (for context "default")
 unbindctxt: remove a key binding for given context
      reset: reset a key to default binding (for context "default")
  resetctxt: reset a key to default binding, for given context
   resetall: restore bindings to the default values and delete ALL personal bindings (use carefully!)
    missing: add missing keys (using default bindings), useful after installing new WeeChat version

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.

For context "mouse" (possible in context "cursor" too), key has format: "@area:key" or "@area1>area2:key" where area can be:
          *: any area on screen
       chat: chat area (any buffer)
  chat(xxx): char area for buffer with name "xxx" (full name including plugin)
     bar(*): any bar
   bar(xxx): bar "xxx"
    item(*): any bar item
  item(xxx): bar item "xxx"
The key can start or end with '*' to match many mouse events.
A special value for command with format "hsignal:name" can be used for context mouse, this will send the hsignal "name" with the focus hashtable as argument.
Another special value "-" can be used to disable key (it will be ignored when looking for keys).

Examples:
  key alt-x to toggle nicklist bar:
    /key bind meta-x /bar toggle nicklist
  key alt-r to jump to #weechat IRC channel:
    /key bind meta-r /buffer #weechat
  restore default binding for key alt-r:
    /key reset meta-r
  key "tab" to stop search in buffer:
    /key bindctxt search ctrl-I /input search_stop
  middle button of mouse on a nick to retrieve info on nick:
    /key bindctxt mouse @item(buffer_nicklist):button3 /msg nickserv info ${nick}
layout save/apply/reset layout for buffers and windows
/layout  save [buffers|windows]
         apply [buffers|windows]
         reset [buffers|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.
mouse mouse control
/mouse  enable|disable|toggle [<delay>]

 enable: enable mouse
disable: disable mouse
 toggle: toggle mouse
  delay: delay (in seconds) after which initial mouse state is restored (useful to temporarily disable mouse)

The mouse state is saved in option "weechat.look.mouse".

Examples:
  enable mouse:
    /mouse enable
  toggle mouse for 5 seconds:
    /mouse toggle 5
mute execute a command silently
/mute  [-current | -buffer <name> | -all] command

-current: no output on current buffer
 -buffer: no output on specified buffer
    name: full buffer name (examples: "irc.server.freenode", "irc.freenode.#weechat")
    -all: no output on ALL buffers
 command: command to execute silently (a '/' is automatically added if not found at beginning of command)

If no target is specified (-current, -buffer or -all), then default is to mute WeeChat core buffer only.

Examples:
  config save:
    /mute save
  message to current IRC channel:
    /mute -current msg * hi!
  message to #weechat channel:
    /mute -buffer irc.freenode.#weechat msg #weechat hi!
plugin list/load/unload plugins
/plugin  list|listfull [<name>]
         load <filename> [<arguments>]
         autoload [<arguments>]
         reload [<name> [<arguments>]]
         unload [<name>]

     list: list loaded plugins
 listfull: list loaded plugins (verbose)
     load: load a plugin
 autoload: autoload plugins in system or user directory
   reload: reload a plugin (if no name given, unload all plugins, then autoload plugins)
   unload: unload a plugin (if no name given, unload all plugins)
 filename: plugin (file) to load
     name: a plugin name
arguments: arguments given to plugin on load

Without argument, this command lists loaded plugins.
proxy manage proxies
/proxy  list
        add <name> <type> <address> <port> [<username> [<password>]]
        del <name>|-all
        set <name> <option> <value>

    list: list all proxies
     add: add a new proxy
    name: 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

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 quit WeeChat
/quit  [-yes] [<arguments>]

     -yes: required if option weechat.look.confirm_quit is enabled
arguments: text sent with signal "quit"
           (for example irc plugin uses this text to send quit message to server)
reload reload configuration files from disk
/reload  [<file> [<file>...]]

file: configuration file to reload (without extension ".conf")

Without argument, all files (WeeChat and plugins) are reloaded.
repeat execute a command several times
/repeat  [-interval <delay>] <count> <command>

  delay: delay between execution of commands (in milliseconds)
  count: number of times to execute command
command: command to execute (a '/' is automatically added if not found at beginning of command)

All commands are executed on buffer where this command was issued.

Example:
  scroll 2 pages up:
    /repeat 2 /window page_up
save save configuration files to disk
/save  [<file> [<file>...]]

file: configuration file to save (without extension ".conf")

Without argument, all files (WeeChat and plugins) are saved.
set set config options
/set  [<option> [<value>]]

option: name of an option (can start or end with '*' to list many options)
 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.

Examples:
  display options about highlight:
    /set *highlight*
  add a word to highlight:
    /set weechat.look.highlight "word"
unset unset/reset config options
/unset  <option>

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).

Examples:
  reset one option:
    /unset weechat.look.item_time_format
  reset all color options:
    /unset weechat.color.*
upgrade upgrade WeeChat without disconnecting from servers
/upgrade  [<path_to_binary>]

path_to_binary: path to WeeChat binary (default is current binary)

This command upgrades and reloads a running WeeChat session. The new WeeChat binary must have been compiled or installed with a package manager before running this command.

Note: SSL connections are lost during upgrade, because reload of SSL sessions is currently not possible with GnuTLS. There is automatic reconnection after upgrade.

Upgrade process has 4 steps:
  1. save session into files for core and plugins (buffers, history, ..)
  2. unload all plugins (configuration files (*.conf) are written on disk)
  3. save WeeChat configuration (weechat.conf)
  4. execute new WeeChat binary and reload session.
uptime show WeeChat uptime
/uptime  [-o | -ol]

 -o: send uptime to current buffer as input (english string)
-ol: send uptime to current buffer as input (translated string)
version show WeeChat version and compilation date
/version  [-o | -ol]

 -o: send version to current buffer as input (english string)
-ol: send version to current buffer as input (translated string)
wait schedule a command execution in future
/wait  <number>[<unit>] <command>

 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 seconds:
    /wait 10 /join #test
  set away in 15 minutes:
    /wait 15m /away -all I'm away
  say 'hello' in 2 minutes:
    /wait 2m hello
window manage windows
/window  list
         -1|+1|b#|up|down|left|right [-window <number>]
         <number>
         splith|splitv [-window <number>] [<pct>]
         resize [-window <number>] [+/-]<pct>
         balance
         merge [-window <number>] [all]
         page_up|page_down [-window <number>]
         refresh
         scroll [-window <number>] [+/-]<value>[s|m|h|d|M|y]
         scroll_horiz [-window <number>] [+/-]<value>[%]
         scroll_up|scroll_down|scroll_top|scroll_bottom|scroll_previous_highlight|scroll_next_highlight|scroll_unread [-window <number>]
         swap [-window <number>] [up|down|left|right]
         zoom[-window <number>]

         list: list opened windows (without argument, this list is displayed)
           -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
       number: window number (see /window list)
       splith: split current window horizontally
       splitv: split current window vertically
       resize: resize window size, new size is <pct> percentage of parent window
      balance: balance the sizes of all windows
        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 a number of lines (+/-N) or with time: s=seconds, m=minutes, h=hours, d=days, M=months, y=years
 scroll_horiz: scroll horizontally a number of columns (+/-N) or percentage of window size (this scrolling is possible only on buffers with free content)
    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
scroll_unread: scroll to unread marker
         swap: swap buffers of two windows (with optional direction for target window)
         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
  zoom on window #2:
    /window zoom -window 2

4. Plugins

To learn more about plugin or script development (through API), please read WeeChat Plugin API Reference or WeeChat Scripting Guide.

4.1. Plugins in WeeChat

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 python with command /python.

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

relay

Relay data via network (IRC proxy)

rmodifier

Alter modifier strings with regular expressions

python

Python scripting API

perl

Perl scripting API

ruby

Ruby scripting API

lua

Lua scripting API

tcl

Tcl scripting API

guile

Guile (scheme) scripting API

xfer

File transfer and direct chat

4.2. Alias plugin

Alias plugin lets you create alias for commands (from WeeChat or other plugins).

4.2.1. Commands

alias create an alias for a command
/alias  [-completion <completion>] <alias> [<command> [;<command>...]]

completion: completion for alias (optional, by default completion is done with target command)
            note: you can use %%command to use completion of an existing command
     alias: name of alias (can start or end with "*" for alias listing)
   command: command name with arguments (many commands can be separated by semicolons)

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

To remove an alias, use command /unalias.

Examples:
  alias /split to split window horizontally:
    /alias split /window splith
  alias /hello to say "hello" on all channels but not on #weechat:
    /alias hello /allchan -exclude=#weechat msg * hello
  alias /forcejoin to send IRC command "forcejoin" with completion of /sajoin:
    /alias -completion %%sajoin forcejoin /quote forcejoin

4.3. Aspell plugin

Aspell plugin lets you check spelling in command line. It is possible to use many languages by buffer.

4.3.1. Options (aspell.conf)

  • 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 WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightred)

4.3.2. Commands

aspell aspell plugin configuration
/aspell  dictlist
         enable <lang>
         disable
         addword [<lang>] <word>

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 (see /set aspell.check.commands).

To enable aspell on all buffers, use option "default_dict", for example:
  /set aspell.check.default_dict "en"

4.3.3. Speller options

Speller options can be defined by adding options in section "option" of aspell configuration.

The option name is an aspell configuration option. List of options can be found in a shell with following command:

$ aspell config

For example, to enable option "ignore-case":

/set aspell.option.ignore-case "true"

4.4. Charset plugin

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

4.4.1. Options (charset.conf)

  • 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: "")

4.4.2. Commands

charset change charset for current buffer
/charset  decode|encode <charset>
          reset

 decode: change decoding charset
 encode: change encoding charset
charset: new charset for current buffer
  reset: reset charsets for current buffer

4.4.3. Set charset

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.*

4.4.4. Troubleshooting

For any problem with charsets, please look at WeeChat FAQ.

4.5. Fifo plugin

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 Python scripts (you have to separate them with "\n"):

$ echo -e '*/python unload\n*/python 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'

4.6. IRC plugin

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).

4.6.1. Command line options

It is possible to give URL for one or many IRC servers, as follow:

irc[6][s]://[nick[:password]@]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

4.6.2. Options (irc.conf)

  • irc.color.input_nick

    • description: color for nick in input bar

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightcyan)

  • irc.color.item_away

    • description: color for away item

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • irc.color.item_channel_modes

    • description: color for channel modes, near channel name

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • irc.color.item_lag_counting

    • description: color for lag indicator, when counting (pong not received from server, lag is increasing)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • irc.color.item_lag_finished

    • description: color for lag indicator, when pong has been received from server

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • irc.color.message_join

    • description: color for text in join messages

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • irc.color.message_quit

    • description: color for text in part/quit messages

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: red)

  • irc.color.mirc_remap

    • description: remap mirc colors in messages using a hashtable: keys are "fg,bg" as integers between -1 (not specified) and 15, values are WeeChat color names or numbers (format is: "1,-1:color1;2,7:color2"), example: "1,-1:darkgray;1,2:white,blue" to remap black on any bg to "darkgray" and black on blue to "white,blue"; default WeeChat colors for IRC codes: 0:white, 1:black, 2:blue, 3:green, 4:lightred, 5:red, 6:magenta, 7:brown, 8:yellow, 9: lightgreen, 10:cyan, 11:lightcyan, 12:lightblue, 13:lightmagenta, 14:gray, 15:white

    • type: string

    • values: any string (default value: "1,-1:darkgray")

  • irc.color.nick_prefix

    • description: color for nick prefix (prefix is custom string displayed before nick)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • irc.color.nick_prefixes

    • description: color for nick prefixes using mode char (o=op, h=halfop, v=voice, ..), format is: "o:color1;h:color2;v:color3" (if a mode is not found, WeeChat will try with next modes received from server ("PREFIX"); a special mode "*" can be used as default color if no mode has been found in list)

    • type: string

    • values: any string (default value: "q:lightred;a:lightcyan;o:lightgreen;h:lightmagenta;v:yellow;*:lightblue")

  • irc.color.nick_suffix

    • description: color for nick suffix (suffix is custom string displayed after nick)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • irc.color.notice

    • description: color for text "Notice" in notices

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: green)

  • irc.color.reason_quit

    • description: color for reason in part/quit messages

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • irc.color.topic_new

    • description: color for new channel topic (when topic is changed)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: white)

  • irc.color.topic_old

    • description: color for old channel topic (when topic is changed)

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: darkgray)

  • irc.look.buffer_switch_autojoin

    • description: auto switch to channel buffer when it is auto joined (with server option "autojoin")

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.buffer_switch_join

    • description: auto switch to channel buffer when it is manually joined (with /join command)

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.color_nicks_in_names

    • description: use nick color in output of /names (or list of nicks displayed when joining a channel)

    • type: boolean

    • values: on, off (default value: off)

  • irc.look.color_nicks_in_nicklist

    • description: use nick color in nicklist

    • type: boolean

    • values: on, off (default value: off)

  • 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_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_host_join

    • description: display host in join messages

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.display_host_join_local

    • description: display host in join messages from local client

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.display_host_quit

    • description: display host in part/quit messages

    • 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.display_pv_away_once

    • description: display remote away message only once in private

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.display_pv_back

    • description: display a message in private when user is back (after quit on server)

    • 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_channel

    • description: comma separated list of words to highlight in channel buffers (case insensitive, use "(?-i)" at beginning of words to make them case sensitive; special variables $nick, $channel and $server are replaced by their value), these words are added to buffer local variable "highlight_words" only when buffer is created (it does not affect current buffers), an empty string disables default highlight on nick, examples: "$nick", "(?-i)$nick"

    • type: string

    • values: any string (default value: "$nick")

  • irc.look.highlight_pv

    • description: comma separated list of words to highlight in private buffers (case insensitive, use "(?-i)" at beginning of words to make them case sensitive; special variables $nick, $channel and $server are replaced by their value), these words are added to buffer local variable "highlight_words" only when buffer is created (it does not affect current buffers), an empty string disables default highlight on nick, examples: "$nick", "(?-i)$nick"

    • type: string

    • values: any string (default value: "$nick")

  • irc.look.highlight_server

    • description: comma separated list of words to highlight in server buffers (case insensitive, use "(?-i)" at beginning of words to make them case sensitive; special variables $nick, $channel and $server are replaced by their value), these words are added to buffer local variable "highlight_words" only when buffer is created (it does not affect current buffers), an empty string disables default highlight on nick, examples: "$nick", "(?-i)$nick"

    • type: string

    • values: any string (default value: "$nick")

  • 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_away_message

    • description: display server away message in away bar item

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.item_channel_modes

    • description: display channel modes in "buffer_name" bar item

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.item_channel_modes_hide_key

    • description: hide channel key if modes are displayed in "buffer_name" bar item (this will hide all channel modes arguments if mode +k is set on channel)

    • type: boolean

    • values: on, off (default value: off)

  • 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.item_nick_modes

    • description: display nick modes in "input_prompt" bar item

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.item_nick_prefix

    • description: display nick prefix in "input_prompt" bar item

    • type: boolean

    • values: on, off (default value: on)

  • 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.new_channel_position

    • description: force position of new channel in list of buffers (none = default position (should be last buffer), next = current buffer + 1, near_server = after last channel/pv of server)

    • type: integer

    • values: none, next, near_server (default value: none)

  • irc.look.new_pv_position

    • description: force position of new private in list of buffers (none = default position (should be last buffer), next = current buffer + 1, near_server = after last channel/pv of server)

    • type: integer

    • values: none, next, near_server (default value: none)

  • irc.look.nick_color_force

    • description: force color for some nicks: hash computed with nickname to find color will not be used for these nicks (format is: "nick1:color1;nick2:color2")

    • type: string

    • values: any string (default value: "")

  • irc.look.nick_color_stop_chars

    • description: chars used to stop in nick when computing color with letters of nick (at least one char outside this list must be in string before stopping) (example: nick "|nick|away" with "|" in chars will return color of nick "|nick")

    • type: string

    • values: any string (default value: "_|[")

  • 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.notify_tags_ison

    • description: comma separated list of tags used in messages printed by notify when a nick joins or quits server (result of command ison), for example: "notify_highlight", "notify_message" or "notify_private"

    • type: string

    • values: any string (default value: "notify_message")

  • irc.look.notify_tags_whois

    • description: comma separated list of tags used in messages printed by notify when a nick away status changes (result of command whois), for example: "notify_highlight", "notify_message" or "notify_private"

    • type: string

    • values: any string (default value: "notify_message")

  • irc.look.part_closes_buffer

    • description: close buffer when /part is issued on a channel

    • type: boolean

    • values: on, off (default value: off)

  • irc.look.raw_messages

    • description: number of 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.smart_filter

    • description: filter join/part/quit/nick 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: on)

  • 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.smart_filter_join

    • description: enable smart filter for "join" messages

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.smart_filter_nick

    • description: enable smart filter for "nick" messages

    • type: boolean

    • values: on, off (default value: on)

  • irc.look.smart_filter_quit

    • description: enable smart filter for "part" and "quit" messages

    • type: boolean

    • values: on, off (default value: on)

  • 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.autoreconnect_delay_growing

    • description: growing factor for autoreconnect delay to server (1 = always same delay, 2 = delay*2 for each retry, ..)

    • type: integer

    • values: 1 .. 100 (default value: 2)

  • irc.network.autoreconnect_delay_max

    • description: maximum autoreconnect delay to server (in seconds, 0 = no maximum)

    • type: integer

    • values: 0 .. 86400 (default value: 1800)

  • 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.lag_check

    • description: interval between two checks for lag (in seconds, 0 = never check)

    • type: integer

    • values: 0 .. 604800 (default value: 60)

  • irc.network.lag_disconnect

    • description: disconnect after important lag (in minutes, 0 = never disconnect)

    • type: integer

    • values: 0 .. 10080 (default value: 0)

  • irc.network.lag_min_show

    • description: minimum lag to show (in milliseconds)

    • type: integer

    • values: 0 .. 86400000 (default value: 500)

  • irc.network.lag_refresh_interval

    • description: interval between two refreshs of lag item, when lag is increasing (in seconds)

    • type: integer

    • values: 1 .. 3600 (default value: 1)

  • irc.network.notify_check_ison

    • description: interval between two checks for notify with IRC command "ison" (in minutes)

    • type: integer

    • values: 1 .. 10080 (default value: 1)

  • irc.network.notify_check_whois

    • description: interval between two checks for notify with IRC command "whois" (in minutes)

    • type: integer

    • values: 1 .. 10080 (default value: 5)

  • 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.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.server_default.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.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: 1 .. 65535 (default value: 10)

  • 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.away_check

    • description: interval between two checks for away (in minutes, 0 = never check)

    • type: integer

    • values: 0 .. 10080 (default value: 0)

  • irc.server_default.away_check_max_nicks

    • description: do not check away nicks on channels with high number of nicks (0 = unlimited)

    • type: integer

    • values: 0 .. 1000000 (default value: 25)

  • irc.server_default.capabilities

    • description: comma-separated list of client capabilities to enable for server if they are available (example: "multi-prefix,extended-join")

    • type: string

    • values: any string (default value: "")

  • 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.connection_timeout

    • description: timeout (in seconds) between TCP connection to server and message 001 received, if this timeout is reached before 001 message is received, WeeChat will disconnect from server

    • type: integer

    • values: 1 .. 3600 (default value: 60)

  • irc.server_default.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.server_default.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.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.notify

    • description: notify list for server (you should not change this option but use /notify command instead)

    • 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.sasl_mechanism

    • description: mechanism for SASL authentication

    • type: integer

    • values: plain, dh-blowfish (default value: plain)

  • irc.server_default.sasl_password

    • description: password for SASL authentication

    • type: string

    • values: any string (default value: "")

  • irc.server_default.sasl_timeout

    • description: timeout (in seconds) before giving up SASL authentication

    • type: integer

    • values: 1 .. 3600 (default value: 15)

  • irc.server_default.sasl_username

    • description: username for SASL authentication

    • 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 ("%h" will be replaced by WeeChat home, "~/.weechat" by default)

    • 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_priorities

    • description: string with priorities for gnutls (for syntax, see documentation of function gnutls_priority_init in gnutls manual, common strings are: "PERFORMANCE", "NORMAL", "SECURE128", "SECURE256", "EXPORT", "NONE")

    • type: string

    • values: any string (default value: "NORMAL")

  • 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: "")

4.6.3. Commands

admin find information about the administrator of the server
/admin  [<target>]

target: server
allchan execute a command on all channels of all connected servers
/allchan  [-current] [-exclude=<channel>[,<channel>...]] <command> [<arguments>]

 -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
allserv execute a command on all connected servers
/allserv  [-exclude=<server>[,<server>...]] <command> [<arguments>]

 -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
ban ban nicks or hosts
/ban  [<channel>] [<nick> [<nick>...]]

channel: channel for ban
   nick: user or host to ban

Without argument, this command display ban list for current channel.
connect connect to IRC server(s)
/connect  <server> [<server>...] [-<option>[=<value>]] [-no<option>] [-nojoin] [-switch]
          -all|-open [-nojoin] [-switch]

    server: server name, which can be:
            - internal server name (created by /server add, recommended usage)
            - hostname/port or IP/port (this will create a TEMPORARY server), port is 6667 by default
            - URL with format: irc[6][s]://[nickname[:password]@]irc.example.org[:port][/#channel1][,#channel2[...]]
    option: set option for server (for boolean option, value can be omitted)
  nooption: set boolean option to 'off' (for example: -nossl)
      -all: connect to all servers defined in configuration
     -open: connect to all opened servers that are not currently connected
   -nojoin: do not join any channel (even if autojoin is enabled on server)
   -switch: switch to next server address

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
  /connect irc://nick@irc.oftc.net/#channel
  /connect -switch
ctcp send a CTCP message (Client-To-Client Protocol)
/ctcp  <target> <type> [<arguments>]

 target: nick or channel to send CTCP to
   type: CTCP type (examples: "version", "ping", ..)
arguments: arguments for CTCP
cycle leave and rejoin a channel
/cycle  [<channel>[,<channel>...]] [<message>]

channel: channel name for cycle
message: part message (displayed to other users)
dcc start a DCC (file transfer or direct chat)
/dcc  chat <nick>
      send <nick> <file>

nick: nick for chat or file
file: filename (on local host)

Examples:
  chat with nick "toto":
    /dcc chat toto
  send file "/home/foo/bar.txt" to nick "toto":
    /dcc send toto /home/foo/bar.txt
dehalfop remove channel half-operator status from nick(s)
/dehalfop  <nick> [<nick>...]
deop remove channel operator status from nick(s)
/deop  <nick> [<nick>...]
devoice remove voice from nick(s)
/devoice  <nick> [<nick>...]
die shutdown the server
/die  [<target>]

target: server name
disconnect disconnect from one or all IRC servers
/disconnect  [<server>|-all [<reason>]]

server: server name to disconnect
  -all: disconnect from all servers
reason: reason for quit
halfop give channel half-operator status to nick(s)
/halfop  <nick> [<nick>...]
ignore ignore nicks/hosts from servers or channels
/ignore  list
         add [re:]<nick> [<server> [<channel>]]
         del <number>|-all

     list: list all ignores
      add: add an ignore
     nick: nick or hostname (can be regular expression if "re:" is given or a mask using "*" to replace one or more chars)
      del: delete an ignore
   number: number of ignore to delete (look at list to find it)
     -all: delete all ignores
   server: internal server name where ignore is working
  channel: channel name where ignore is working

Note: the regular expression can start with "(?-i)" to become case sensitive.

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
info get information describing the server
/info  [<target>]

target: server name
invite invite a nick on a channel
/invite  <nick> <channel>

   nick: nick to invite
channel: channel to invite
ison check if a nick is currently on IRC
/ison  <nick> [<nick>...]

nick: nick
join join a channel
/join  [-server <server>] [<channel1>[,<channel2>...]] [<key1>[,<key2>...]]

 server: send to this server (internal name)
channel: channel name to join
    key: key to join the channel (channels with a key must be the first in list)

Examples:
  /join #weechat
  /join #protectedchan,#weechat key
  /join -server freenode #weechat
kick forcibly remove a user from a channel
/kick  [<channel>] <nick> [<reason>]

channel: channel where user is
   nick: nick to kick
 reason: reason for kick
kickban kicks and bans a nick from a channel
/kickban  [<channel>] <nick> [<reason>]

channel: channel where user is
   nick: nick to kick and ban
 reason: reason for kick

It is possible to kick/ban with a mask, nick will be extracted from mask and replaced by "*".

Example:
  ban "*!*@host.com" and then kick "toto":
    /kickban toto!*@host.com
kill close client-server connection
/kill  <nick> <reason>

  nick: nick to kill
reason: reason for kill
/links  [[<server>] <server_mask>]

     server: this server should answer the query
server_mask: list of servers must match this mask
list list channels and their topic
/list  [<channel>[,<channel>...]] [<server>] [-re <regex>]

channel: channel to list
 server: server name
  regex: regular expression used to filter results (case insensitive, can start by "(?-i)" to become case sensitive)

Examples:
  list all channels on server (can be very slow on large networks):
    /list
  list channel #weechat:
    /list #weechat
  list all channels beginning with "#weechat" (can be very slow on large networks):
    /list -re #weechat.*
lusers get statistics about the size of the IRC network
/lusers  [<mask> [<target>]]

  mask: servers matching the mask only
target: server for forwarding request
map show a graphical map of the IRC network
me send a CTCP action to the current channel
/me  <message>

message: message to send
mode change channel or user mode
/mode  [<channel>] [+|-]o|p|s|i|t|n|m|l|b|e|v|k [<arguments>]
       <nick> [+|-]i|s|w|o

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:
  nick: nick to modify
  i: mark a user as invisible
  s: mark a user for receive server notices
  w: user receives wallops
  o: operator flag

List of modes is not comprehensive, you should read documentation about your server to see all possible modes.

Examples:
  protect topic on channel #weechat:
    /mode #weechat +t
  become invisible on server:
    /mode nick +i
motd get the "Message Of The Day"
/motd  [<target>]

target: server name
msg send message to a nick or channel
/msg  [-server <server>] <target>[,<target>...] <text>

server: send to this server (internal name)
target: nick or channel (may be mask, '*' = current channel)
  text: text to send
names list nicks on channels
/names  [<channel>[,<channel>...]]

channel: channel name
nick change current nick
/nick  [-all] <nick>

-all: set new nick for all connected servers
nick: new nick
notice send notice message to user
/notice  [-server <server>] <target> <text>

server: send to this server (internal name)
target: nick or channel
  text: text to send
notify add a notification for presence or away status of nicks on servers
/notify  add <nick> [<server> [-away]]
         del <nick>|-all [<server>]

   add: add a notification
  nick: nick
server: internal server name (by default current server)
 -away: notify when away message is changed (by doing whois on nick)
   del: delete a notification
  -all: delete all notifications

Without argument, this command displays notifications for current server (or all servers if command is issued on core buffer).

Examples:
  notify when "toto" joins/quits current server:
    /notify add toto
  notify when "toto" joins/quits freenode server:
    /notify add toto freenode
  notify when "toto" is away or back on freenode server:
    /notify add toto freenode -away
op give channel operator status to nick(s)
/op  <nick> [<nick>...]
oper get operator privileges
/oper  <user> <password>

    user: user
password: password
part leave a channel
/part  [<channel>[,<channel>...]] [<message>]

channel: channel name to leave
message: part message (displayed to other users)
ping send a ping to server
/ping  <server1> [<server2>]

server1: server
server2: forward ping to this server
pong answer to a ping message
/pong  <daemon> [<daemon2>]

 daemon: daemon who has responded to Ping message
daemon2: forward message to this daemon
query send a private message to a nick
/query  [-server <server>] <nick> [<text>]

server: send to this server (internal name)
  nick: nick for private conversation
  text: text to send
quote send raw data to server without parsing
/quote  [-server <server>] <data>

server: send to this server (internal name)
  data: raw data to send
reconnect reconnect to server(s)
/reconnect  <server> [<server>...] [-nojoin] [-switch]
            -all [-nojoin] [-switch]

 server: server name to reconnect
   -all: reconnect to all servers
-nojoin: do not join any channel (even if autojoin is enabled on server)
-switch: switch to next server address
rehash tell the server to reload its config file
/rehash  [<option>]

option: extra option, for some servers
restart tell the server to restart itself
/restart  [<target>]

target: server name
sajoin force a user to join channel(s)
/sajoin  <nick> <channel>[,<channel>...]

   nick: nick
channel: channel name
samode change mode on channel, without having operator status
/samode  <channel> <mode>

channel: channel name
   mode: mode for channel
sanick force a user to use another nick
/sanick  <nick> <new_nick>

    nick: nick
new_nick: new nick
sapart force a user to leave channel(s)
/sapart  <nick> <channel>[,<channel>...]

   nick: nick
channel: channel name
saquit force a user to quit server with a reason
/saquit  <nick> <reason>

  nick: nick
reason: reason
server list, add or remove IRC servers
/server  list|listfull [<server>]
         add <server> <hostname>[/<port>] [-temp] [-<option>[=<value>]] [-no<option>]
         copy|rename <server> <new_name>
         del|keep <server>
         deloutq|jump|raw

    list: list servers (without argument, this list is displayed)
listfull: list servers with detailed info for each server
     add: create a new server
  server: server name, for internal and display use
hostname: name or IP address of server, with optional port (default: 6667), many addresses can be separated by a comma
    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 add freenode3 irc.freenode.net -password=mypass
  /server copy oftc oftcbis
  /server rename oftc newoftc
  /server del freenode
  /server deloutq
service register a new service
/service  <nick> <reserved> <distribution> <type> <reserved> <info>

distribution: visibility of service
        type: reserved for future usage
servlist list services currently connected to the network
/servlist  [<mask> [<type>]]

mask: list only services matching this mask
type: list only services of this type
squery deliver a message to a service
/squery  <service> <text>

service: name of service
   text: text to send
squit disconnect server links
/squit  <server> <comment>

 server: server name
comment: comment for quit
stats query statistics about server
/stats  [<query> [<server>]]

 query: c/h/i/k/l/m/o/y/u (see RFC1459)
server: server name
summon give users who are on a host running an IRC server a message asking them to please join IRC
/summon  <user> [<target> [<channel>]]

   user: username
 target: server name
channel: channel name
time query local time from server
/time  [<target>]

target: query time from specified server
topic get/set channel topic
/topic  [<channel>] [<topic>|-delete]

channel: channel name
  topic: new topic for channel
-delete: delete channel topic
trace find the route to specific server
/trace  [<target>]

target: server
unban unban nicks or hosts
/unban  [<channel>] <nick> [<nick>...]

channel: channel for unban
   nick: user or host to unban
userhost return a list of information about nicks
/userhost  <nick> [<nick>...]

nick: nick
users list of users logged into the server
/users  [<target>]

target: server
version give the version info of nick or server (current or specified)
/version  [<server>|<nick>]

server: server name
  nick: nick
voice give voice to nick(s)
/voice  <nick> [<nick>...]
wallchops send a notice to channel ops
/wallchops  [<channel>] <text>

channel: channel name
   text: text to send
wallops send a message to all currently connected users who have set the w user mode for themselves
/wallops  <text>

text: text to send
who generate a query which returns a list of information
/who  [<mask> [o]]

mask: only information which match this mask
   o: only operators are returned according to the mask supplied
whois query information about user(s)
/whois  [<server>] <nick>[,<nick>...]

server: server name
  nick: nick (may be a mask)
whowas ask for information about a nick which no longer exists
/whowas  <nick>[,<nick>...] [<count> [<target>]]

  nick: nick to search
 count: number of replies to return (full search if negative number)
target: reply should match this mask

4.6.4. SSL certificates

When connecting to IRC server with SSL, WeeChat checks by default that the connection is fully trusted.

Some options are used to control SSL connection:

weechat.network.gnutls_ca_file

path to file with certificate authorities (by default: "%h/ssl/CAs.pem")

irc.server.xxx.ssl_cert

SSL certificate file used to automatically identify your nick (for example CertFP on oftc, see below)

irc.server.xxx.ssl_dhkey_size

size of the key used during the Diffie-Hellman Key Exchange (by default: 2048)

irc.server.xxx.ssl_verify

check that the SSL connection is fully trusted (on by default)

Note
Option "ssl_verify" is on by default, so verification is strict and may fail, even if it was ok with versions prior to 0.3.1.
First example: connect to oftc and check certificate
  • Import certificate in shell:

$ mkdir ~/.weechat/ssl
$ wget -O ~/.weechat/ssl/CAs.pem http://www.spi-inc.org/ca/spi-cacert.crt

Note: it is possible to concatenate many certificates in file CAs.pem.

  • In WeeChat, with "oftc" server already created:

/connect oftc
Second example: connect to oftc using CertFP
  • Create certificate in shell:

$ openssl req -nodes -newkey rsa:2048 -keyout nick.key -x509 -days 365 -out nick.cer
$ cat nick.cer nick.key > ~/.weechat/ssl/nick.pem
  • In WeeChat, with "oftc" server already created:

/set irc.server.oftc.ssl_cert "%h/ssl/nick.pem"
/connect oftc
/msg nickserv cert add

For more information, look at http://www.oftc.net/oftc/NickServ/CertFP

4.6.5. SASL authentication

WeeChat supports SASL authentication, using two mechanisms: "plain" (default) or "dh-blowfish" (crypted password).

Options in servers are:

  • sasl_mechanism: mechanism to use ("plain" or "dh-blowfish")

  • sasl_timeout: timeout (in seconds) for authentication

  • sasl_username: username (nick)

  • sasl_password: password

If you want to use "dh-blowfish" by default for all servers:

/set irc.server_default.sasl_mechanism dh-blowfish
Note
The "gcrypt" library is required when compiling WeeChat in order to use "dh-blowfish" mechanism (see dependencies).

4.6.6. Connect to Freenode with TOR/SASL

In addition to SSL, Freenode servers support connections with TOR (https://www.torproject.org/), a network of virtual tunnels that allows people and groups to improve their privacy and security on the Internet.

First, make sure to have WeeChat compiled with libgcrypt11-dev (if built from sources); it’s not mandatory, but "dh-blowfish" ensures stronger security compared to "plain" authentication system with SASL.

In first place, install TOR. For Debian (and derivated):

$ sudo apt-get install tor

In WeeChat you need to create a socks5 proxy for TOR service (hostname/IP and port depend on your TOR configuration):

/proxy add tor socks5 127.0.0.1 9050

Now, create a new server, for example:

/server add freenode-tor p4fsi4ockecnea7l.onion

Set proxy for TOR:

/set irc.server.freenode-tor.proxy "tor"

Set SASL authentication:

/set irc.server.freenode-tor.sasl_mechanism dh-blowfish
/set irc.server.freenode-tor.sasl_username "your_nickname"
/set irc.server.freenode-tor.sasl_password "your_password"

And finally, connection to server:

/connect freenode-tor

For more info about Freenode and TOR: http://freenode.net/irc_servers.shtml#tor

4.6.7. Smart filter for join/part/quit messages

A smart filter is available to filter join/part/quit messages when nick did not say something during past X minutes on channel.

Smart filter is enabled by default, but you must add a filter to hide lines on buffers, for example:

/filter add irc_smart * irc_smart_filter *

It is possible to create filter for one channel only or channels beginning with same name (see /help filter):

/filter add irc_smart_weechat irc.freenode.#weechat irc_smart_filter *
/filter add irc_smart_weechats irc.freenode.#weechat* irc_smart_filter *

You can hide only join or part/quit with following options:

/set irc.look.smart_filter_join on
/set irc.look.smart_filter_quit on

You can setup delay (in minutes):

/set irc.look.smart_filter_delay 5

If a nick did not speak during last 5 minutes, its join and/or part/quit will be hidden on channel.

4.6.8. CTCP replies

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    

user name on IRC server

 nick
 $realname    

real name 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)

4.6.9. Target buffer for IRC messages

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

current buffer (if it’s IRC buffer, or on server buffer by default)

private

private buffer for nick, or current/server buffer if not found (according to option irc.look.msgbuffer_fallback)

server

server buffer

weechat

WeeChat "core" buffer

When option is not set (default), WeeChat chooses appropriate buffer, commonly server or channel buffer.

Non-comprehensive list of IRC messages or alias that you can customize:

message alias description

error

error

invite

invited on a channel

join

join

kick

kick

kill

kill

mode

mode

notice

notice

part

part

quit

quit

topic

topic

wallops

wallops

ctcp

ctcp (sent or received, in a privmsg or notice message)

221

user mode string

275

whois

whois (secure connection)

301

whois

whois (away)

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)

328

channel URL

329

channel creation date

330

whois

whois (logged in as)

331

no topic for channel

332

topic of channel

333

infos about topic

335

whois

whois (is a bot on)

338

whois

whois (host)

341

inviting

343

whois

whois (is opered as)

344

reop

channel reop

345

reop

channel reop (end)

346

invitelist

invite list

347

invitelist

invite list (end)

348

exceptionlist

exception list

349

exceptionlist

exception list (end)

351

server version

352

who

who

353

names

list of users on channel

366

names

end of /names list

367

banlist

ban list

368

banlist

end of ban list

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

4.7. Logger plugin

The Logger plugin lets you save content of buffers to files, with options about what and how it is saved.

4.7.1. Options (logger.conf)

  • 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.flush_delay

    • description: number of seconds between flush of log files (0 = write in log files immediately for each line printed)

    • type: integer

    • values: 0 .. 3600 (default value: 120)

  • 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; date specifiers are permitted (see man strftime)

    • 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" at beginning of string is replaced by WeeChat home ("~/.weechat" by default); date specifiers are permitted (see man strftime)

    • 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)

4.7.2. Commands

logger logger plugin configuration
/logger  list
         set <level>
         disable

   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.

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

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"

4.7.3. Log levels

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

4.7.4. Filenames masks

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, on buffer "irc.freenode.#weechat", WeeChat will search a mask with option name, in this order:

logger.mask.irc.freenode.#weechat
logger.mask.irc.freenode
logger.mask.irc
logger.file.mask

That means you can have masks specific for some IRC servers ("logger.mask.irc.freenode") or for a plugin ("logger.mask.irc").

Log files by date

To have log files by date, you can use date/time specifiers in mask (see man strftime for formats), for example:

/set logger.file.mask "%Y/%m/$plugin.$name.weechatlog"

You’ll have following files:

~/.weechat/
    |--- logs/
        |--- 2010/
            |--- 11/
            |       irc.server.freenode.weechatlog
            |       irc.freenode.#weechat.weechatlog
        |--- 2010/
            |--- 12/
            |       irc.server.freenode.weechatlog
            |       irc.freenode.#weechat.weechatlog
IRC log files by server and channel

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

4.8. Relay plugin

The Relay plugin is used to relay data via network, using different protocols:

  • irc: IRC proxy: used to share connections to IRC servers with one or many other IRC clients

  • weechat: protocol used by remote interfaces to display and interact with WeeChat (for example QWeeChat)

4.8.1. Options (relay.conf)

  • relay.color.status_active

    • description: text color for "connected" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightblue)

  • relay.color.status_auth_failed

    • description: text color for "authentication failed" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightred)

  • relay.color.status_connecting

    • description: text color for "connecting" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • relay.color.status_disconnected

    • description: text color for "disconnected" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightred)

  • relay.color.status_waiting_auth

    • description: text color for "waiting authentication" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: brown)

  • relay.color.text

    • description: text color

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • relay.color.text_bg

    • description: background color

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • relay.color.text_selected

    • description: text color of selected client line

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: white)

  • relay.look.auto_open_buffer

    • description: auto open relay buffer when a new client is connecting

    • type: boolean

    • values: on, off (default value: on)

  • relay.look.raw_messages

    • description: number of 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)

  • relay.network.allowed_ips

    • description: regular expression with IPs allowed to use relay (case insensitive, use "(?-i)" at beginning to make it case sensitive), example: "^(123.45.67.89|192.160.*)$"

    • type: string

    • values: any string (default value: "")

  • relay.network.bind_address

    • description: address for bind (if empty, connection is possible on all interfaces, use "127.0.0.1" to allow connections from local machine only)

    • type: string

    • values: any string (default value: "")

  • relay.network.compression_level

    • description: compression level for packets sent to client with WeeChat protocol (0 = disable compression, 1 = low compression ... 9 = best compression)

    • type: integer

    • values: 0 .. 9 (default value: 6)

  • relay.network.max_clients

    • description: maximum number of clients connecting to a port

    • type: integer

    • values: 1 .. 1024 (default value: 5)

  • relay.network.password

    • description: password required by clients to access this relay (empty value means no password required)

    • type: string

    • values: any string (default value: "")

4.8.2. Commands

relay relay control
/relay  list|listfull|listrelay
        add <protocol.name> <port>
        del <protocol.name>
        raw

         list: list relay clients (only active relays)
     listfull: list relay clients (verbose, all relays)
    listrelay: list relays (name and port)
          add: add relay for a protocol + name
          del: remove relay for a protocol + name
protocol.name: protocol and name to relay:
                 - protocol "irc": name is the server to share
                 - protocol "weechat" (name is not used)
         port: port used for relay
          raw: open buffer with raw Relay data

Without argument, this command opens buffer with list of relay clients.

Examples:
  irc proxy, for server "freenode":
    /relay add irc.freenode 8000
  weechat protocol:
    /relay add weechat 8001

4.8.3. IRC proxy

The Relay plugin can act as an IRC proxy: you can define one port by IRC server and use a password for clients.

For example:

/set relay.network.password "mypass"
/relay add irc.freenode 8000

Now you can connect on port 8000 with any IRC client (WeeChat, xchat, irssi, ..), using server password "mypass".

You can limit number of allowed clients:

/set relay.network.max_clients 1

4.8.4. WeeChat protocol

The Relay plugin can send data to remote interface using WeeChat protocol.

For example:

/set relay.network.password "mypass"
/relay add weechat 9000

Now you can connect on port 9000 with a remote interface (like QWeeChat), using password "mypass".

4.9. Rmodifier plugin

The Rmodifier plugin lets you alter modifier strings using regular expressions. Typical use is to hide password when you type them, or when WeeChat saves them in command history. For example, it is possible to replace each char in these passwords by *.

4.9.1. Options (rmodifier.conf)

  • rmodifier.look.hide_char

    • description: char used to hide part of a string

    • type: string

    • values: any string (default value: "*")

4.9.2. Commands

rmodifier alter modifier strings with regular expressions
/rmodifier  list|listdefault
            add <name> <modifiers> <groups> <regex>
            del <name>|-all [<name>...]
            default -yes

       list: list all rmodifiers
listdefault: list default rmodifiers
        add: add a rmodifier
       name: name of rmodifier
  modifiers: comma separated list of modifiers
     groups: action on groups found: comma separated list of groups (from 1 to 9) with optional "*" after number to hide group
      regex: regular expression (case insensitive, can start by "(?-i)" to become case sensitive)
        del: delete a rmodifier
       -all: delete all rmodifiers
    default: restore default rmodifiers

Examples:
  hide everything typed after a command /password:
    /rmodifier add password input_text_display 1,2* ^(/password +)(.*)
  delete rmodifier "password":
    /rmodifier del password
  delete all rmodifiers:
    /rmodifier del -all

4.9.3. Rmodifier creation

A rmodifier consists of three elements:

  1. one or more "modifiers"

  2. a regular expression, to capture "groups"

  3. a string that describes output using number of "groups" captured in regular expression

For list of modifiers used by WeeChat or plugins, see WeeChat Plugin API Reference, function weechat_hook_modifier.

For each captured group, following actions are possible:

  • keep group as-is (by using group number)

  • replace all chars in group to hide content (group number + *)

  • remove group (if group is not used in string)

Example of default rmodifier for command /oper:

  • modifiers: history_add,input_text_display

    • history_add: called when WeeChat stores command in history

    • input_text_display: called when command line has changed (applies only on display, not content of command line)

  • regular expression: ^(/oper +\S+ +)(.*)

  • groupes: 1,2*

Each time modifiers "history_add" or "input_text_display" are called, regular expression is checked. If string matches, then it is replaced by captured groups, as defined in string with groups.

In this example, we keep number 1 as-is, and we replace all chars of group 2 by replacement char defined in configuration (option rmodifier.look.hide_char).

If command line contains: /oper nick password then display becomes: /oper nick ********.

4.10. Scripts plugins

WeeChat provides 6 scripting plugins: Python, Perl, Ruby, Lua, Tcl and Guile (scheme). 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

4.10.1. Python commands

python list/load/unload scripts
/python  list|listfull [<name>]
         load <filename>
         autoload
         reload|unload [<name>]

    list: list loaded scripts
listfull: list loaded scripts (verbose)
    load: load a script
autoload: load all scripts in "autoload" directory
  reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory)
  unload: unload a script (if no name given, unload all scripts)
filename: script (file) to load
    name: a script name (name used in call to "register" function)

Without argument, this command lists all loaded scripts.

4.10.2. Perl commands

perl list/load/unload scripts
/perl  list|listfull [<name>]
       load <filename>
       autoload
       reload|unload [<name>]

    list: list loaded scripts
listfull: list loaded scripts (verbose)
    load: load a script
autoload: load all scripts in "autoload" directory
  reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory)
  unload: unload a script (if no name given, unload all scripts)
filename: script (file) to load
    name: a script name (name used in call to "register" function)

Without argument, this command lists all loaded scripts.

4.10.3. Ruby commands

ruby list/load/unload scripts
/ruby  list|listfull [<name>]
       load <filename>
       autoload
       reload|unload [<name>]

    list: list loaded scripts
listfull: list loaded scripts (verbose)
    load: load a script
autoload: load all scripts in "autoload" directory
  reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory)
  unload: unload a script (if no name given, unload all scripts)
filename: script (file) to load
    name: a script name (name used in call to "register" function)

Without argument, this command lists all loaded scripts.

4.10.4. Lua commands

lua list/load/unload scripts
/lua  list|listfull [<name>]
      load <filename>
      autoload
      reload|unload [<name>]

    list: list loaded scripts
listfull: list loaded scripts (verbose)
    load: load a script
autoload: load all scripts in "autoload" directory
  reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory)
  unload: unload a script (if no name given, unload all scripts)
filename: script (file) to load
    name: a script name (name used in call to "register" function)

Without argument, this command lists all loaded scripts.

4.10.5. Tcl commands

tcl list/load/unload scripts
/tcl  list|listfull [<name>]
      load <filename>
      autoload
      reload|unload [<name>]

    list: list loaded scripts
listfull: list loaded scripts (verbose)
    load: load a script
autoload: load all scripts in "autoload" directory
  reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory)
  unload: unload a script (if no name given, unload all scripts)
filename: script (file) to load
    name: a script name (name used in call to "register" function)

Without argument, this command lists all loaded scripts.

4.10.6. Guile commands

guile list/load/unload scripts
/guile  list|listfull [<name>]
        load <filename>
        autoload
        reload|unload [<name>]

    list: list loaded scripts
listfull: list loaded scripts (verbose)
    load: load a script
autoload: load all scripts in "autoload" directory
  reload: reload a script (if no name given, unload all scripts, then load all scripts in "autoload" directory)
  unload: unload a script (if no name given, unload all scripts)
filename: script (file) to load
    name: a script name (name used in call to "register" function)

Without argument, this command lists all loaded scripts.

4.11. Xfer plugin

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

4.11.1. Options (xfer.conf)

  • xfer.color.status_aborted

    • description: text color for "aborted" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightred)

  • xfer.color.status_active

    • description: text color for "active" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightblue)

  • xfer.color.status_connecting

    • description: text color for "connecting" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: yellow)

  • xfer.color.status_done

    • description: text color for "done" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightgreen)

  • xfer.color.status_failed

    • description: text color for "failed" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightred)

  • xfer.color.status_waiting

    • description: text color for "waiting" status

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: lightcyan)

  • xfer.color.text

    • description: text color

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • xfer.color.text_bg

    • description: background color

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: default)

  • xfer.color.text_selected

    • description: text color of selected xfer line

    • type: color

    • values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (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 ("%h" will be replaced by WeeChat home, "~/.weechat" by default)

    • 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) ("%h" will be replaced by WeeChat home, "~/.weechat" by default)

    • 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)

4.11.2. Commands

me send a CTCP action to remote host
/me  <message>

message: message to send
xfer xfer control
/xfer  [list|listfull]

    list: list xfer
listfull: list xfer (verbose)

Without argument, this command opens buffer with xfer list.

5. Authors

5.1. Developers

Main developer

Sébastien Helleu (FlashCode)

5.2. Contributors

Packagers

Emmanuel Bouthenot (kolter), Julien Louis (ptitlouis), Odin

Translations

Jiri Golembiovsky, soltys, Nils Görs, rettub, Frank Zacharias, Pavel Shevchuk, Elián Hanisch (m4v), Voroskoi, Marco Paolone, Ivan Sichmann Freitas, Lázaro A.

Patches

Dmitry Kobylin, Rudolf Polzer, Jim Ramsay, Pistos, Gwenn, Dominik Honnef, JD Horelick, Stefano Pigozzi, Gu1ll4um3r0m41n

6. 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!).

Ways to get support: