This manual documents WeeChat chat client, it is part of WeeChat.
Latest version of this document can be found on this page ↗.
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 (mainly IRC)
-
multi-servers connection (with TLS, IPv6, proxy)
-
small, fast and light
-
customizable and extensible with plugins and scripts
-
compliant with IRC RFCs 1459 ↗, 2810 ↗, 2811 ↗, 2812 ↗, 2813 ↗ and 7194 ↗
-
IRC proxy and relay for WeeChat and remote interfaces
-
multi-platform (GNU/Linux, *BSD, macOS, Windows and other)
-
100% GPL, free software
The list of all features can be found on this page ↗.
1.2. Prerequisites
In order to install WeeChat, you need:
-
a running GNU/Linux system (with compiler tools for source package), or a compatible OS
-
root privileges (to install WeeChat in a system directory)
-
some libraries (see dependencies)
2. Installation
2.1. Binary packages
Binary packages are available for many distributions, including:
-
Arch Linux:
pacman -S weechat
-
Cygwin (Windows): select WeeChat packages in setup.exe
-
Debian/Ubuntu (or any Debian compatible distribution):
apt-get install weechat-curses weechat-plugins
For latest versions and nightly builds: Debian repositories ↗ -
Fedora Core:
dnf install weechat
-
FreeBSD:
pkg install weechat
-
Gentoo:
emerge weechat
-
Mandriva/RedHat (or any RPM compatible distribution):
rpm -i /path/to/weechat-x.y.z-1.i386.rpm
-
openSUSE:
zypper in weechat
-
Sourcemage:
cast weechat
-
macOS (with Homebrew ↗):
brew install weechat
(for help:brew info weechat
)
Some additional packages may be useful, like weechat-plugins.
For other distributions, please look at your manual for installation instructions.
2.2. Containers
Containers with WeeChat can be built or installed directly from the
Docker Hub ↗.
For more information, see the README in the
weechat-container ↗
repository.
2.3. Source package
WeeChat must be built with CMake.
Note
|
On macOS, you can use Homebrew ↗:
brew install --build-from-source weechat .
|
Dependencies
The following table shows the list of packages that are required to build WeeChat:
Package (1) | Version | Features |
---|---|---|
C compiler (gcc / clang) |
Compile C sources. |
|
cmake |
≥ 3.0 |
Build. |
pkgconf / pkg-config |
Detect installed libraries. |
|
libncurses-dev |
Ncurses interface. |
|
libcurl4-gnutls-dev |
URL transfer. |
|
libgcrypt20-dev |
Secured data, IRC SASL authentication. |
|
libgnutls28-dev |
≥ 2.2.0 (2) |
IRC plugin: support of TLS connections, IRC SASL authentication (ECDSA-NIST256P-CHALLENGE). |
zlib1g-dev |
Logger plugin: compression of rotated log files (gzip). |
Note
|
(1) Name comes from the Debian GNU/Linux Bookworm distribution, version and
name can be different in other distributions. (2) GnuTLS ≥ 3.0.21 is required for IRC SASL authentication with mechanism ECDSA-NIST256P-CHALLENGE. |
The following table shows the list of packages that are optional to compile WeeChat:
Package (1) | Version | Features |
---|---|---|
C++ compiler (g++ / clang++) |
Build and run tests, JavaScript plugin. |
|
gettext |
Internationalization (translation of messages; base language is English). |
|
ca-certificates |
Certificates for TLS connections. |
|
libcjson-dev |
Relay plugin: protocol "api" (HTTP REST API). |
|
libzstd-dev |
≥ 0.8.1 |
Logger plugin: compression of rotated log files (zstandard). |
libaspell-dev / libenchant-dev |
Spell plugin. |
|
python3-dev |
≥ 3.0 |
Python plugin. |
libperl-dev |
Perl plugin. |
|
ruby3.1, ruby3.1-dev |
≥ 1.9.1 |
Ruby plugin. |
liblua5.4-dev |
Lua plugin. |
|
tcl-dev |
≥ 8.5 |
Tcl plugin. |
guile-3.0-dev |
≥ 2.0 |
Guile (scheme) plugin. |
libv8-dev |
≤ 3.24.3 |
JavaScript plugin. |
php-dev |
≥ 7.0 |
PHP plugin. |
libphp-embed |
≥ 7.0 |
PHP plugin. |
libxml2-dev |
PHP plugin. |
|
libargon2-dev |
PHP plugin (if PHP ≥ 7.2). |
|
libsodium-dev |
PHP plugin (if PHP ≥ 7.2). |
|
asciidoctor |
≥ 1.5.4 |
Build man page and documentation. |
ruby-pygments.rb |
Build documentation. |
|
libcpputest-dev |
≥ 3.4 |
Build and run tests. |
Note
|
(1) Name comes from the Debian GNU/Linux Bookworm distribution, version and name can be different in other distributions. |
If you are using a Debian/Ubuntu based distribution, and if you have some "deb-src" source entries in your file /etc/apt/sources.list, you can install all dependencies with the command:
sudo apt-get build-dep weechat
Build
-
Installation in system directories (requires root privileges):
mkdir build
cd build
cmake ..
make
sudo make install
-
Installation in custom directory (for example your home):
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory
make
make install
Options can be used for CMake, with format: -DOPTION=VALUE
.
List of available options:
Option | Values | Default value | Description |
---|---|---|---|
|
|
The type of build: |
|
|
directory |
|
The directory where WeeChat will be installed. |
|
directory |
|
The default home directory when running WeeChat. |
|
|
|
Compile Alias plugin. |
|
|
|
Compile Buflist plugin. |
|
|
|
Compile Charset plugin. |
|
|
|
Support of JSON with cJSON ↗ library. |
|
|
|
Build man page. |
|
|
|
Build HTML documentation. |
|
|
|
Force build of documentation even if some plugins are not compiled (not recommended: docs will be incomplete). |
|
|
|
Compile Spell plugin with Enchant. |
|
|
|
Compile Exec plugin. |
|
|
|
Compile Fifo plugin. |
|
|
|
Compile Fset plugin. |
|
|
|
Compile Guile plugin (Scheme). |
|
|
|
Compile headless binary. |
|
|
|
Compile IRC plugin. |
|
|
|
Compile JavaScript plugin. |
|
|
|
Support of large files. |
|
|
|
Compile Logger plugin. |
|
|
|
Compile Lua plugin. |
|
|
|
Compile Ncurses interface. |
|
|
|
Enable NLS (translations). |
|
|
|
Compile Perl plugin. |
|
|
|
Compile PHP plugin. |
|
|
|
Compile Python plugin. |
|
|
|
Compile Relay plugin. |
|
|
|
Compile Ruby plugin. |
|
|
|
Compile Script plugin. |
|
|
|
Compile script plugins (Python, Perl, Ruby, Lua, Tcl, Guile, PHP). |
|
|
|
Compile Spell plugin. |
|
|
|
Compile Tcl plugin. |
|
|
|
Compile Trigger plugin. |
|
|
|
Compile Typing plugin. |
|
|
|
Compile Xfer plugin. |
|
|
|
Enable Zstandard ↗ compression. |
|
|
|
Compile tests. |
|
|
|
Compile with code coverage options. |
The other options can be displayed with this command:
cmake -LA
Or with Curses interface:
ccmake ..
2.4. 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 https://github.com/weechat/weechat.git
Then follow instructions for source package (see source package).
2.5. Report crashes
If you experienced crashes, or if you want to report any future WeeChat crash, you have to:
-
Compile with:
-
debug info (or install binary package with debug info),
-
address sanitizer (optional).
-
-
Enable core files on your system.
-
Install gdb.
Address sanitizer
You can additionally enable the address sanitizer, which causes WeeChat to crash immediately in case of problem:
cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-fsanitize=address -DCMAKE_CXX_FLAGS=-fsanitize=address -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address
Caution
|
You should enable address sanitizer only if you’re trying to cause a crash, this is not recommended in production. |
Then once compiled and installed, you must run WeeChat like this:
ASAN_OPTIONS="detect_odr_violation=0 log_path=asan.log" weechat
In case of crash, the backtrace is in file asan.log
.
Core files
To enable core files, you can use option weechat.startup.sys_rlimit:
/set weechat.startup.sys_rlimit "core:-1"
For WeeChat ≤ 0.3.8 or if you want to enable core files even before WeeChat
starts, you can 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
Get backtrace with gdb
When WeeChat crashes, your system will create a file core or core.12345 (12345 is process id) if the option is enabled. This file is created in directory where you have run WeeChat (this is not directory where WeeChat is installed!).
Note
|
On some systems like Archlinux, core dumps could be in another directory like
/var/lib/systemd/coredump and you must use the command coredumpctl to read it.For more information, see this wiki page ↗. |
For example if weechat is installed in /usr/bin/ and core file is in /home/user/, then run gdb with this command:
gdb /usr/bin/weechat /home/user/core
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/core-hook.c:1364 hook_process = 0x254eb90 status = <value optimized out> #5 0x000000000044cc7d in hook_timer_exec () at /some_path/src/core/core-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!
3. Running WeeChat
To start WeeChat, issue this command:
weechat
When you run WeeChat for the first time, the default configuration files are created in ~/.config/weechat with default options and values (see Files and directories).
3.1. Command line options
- -a, --no-connect
-
Disable auto-connect to servers when WeeChat is starting.
- -c, --colors
-
Display default colors in terminal.
- --daemon
-
Run WeeChat in background, as a daemon (works only with the command weechat-headless).
- --stdout
-
Display log messages on standard output instead of writing them in log file (works only with the command weechat-headless, not compatible with option "--daemon").
- -d, --dir <path>
-
Force a single directory for all WeeChat files (directory is created if not found). Four directories can be given, separated by colons (in this order: config, data, cache, runtime). If this option is not given, the environment variable WEECHAT_HOME is used (if not empty).
- -t, --temp-dir
-
Create a temporary WeeChat home directory and delete it on exit (incompatible with option "-d").
The name of the directory is automatically built by WeeChat, with this template: "weechat_temp_XXXXXX" (where "XXXXXX" is random). It it created in the first available directory in this list: environment variable "TMPDIR", "/tmp" (may be different according to the operating system), environment variable "HOME", current directory.
The temporary home directory has permissions 0700 (only owner can read, write and execute). - -h, --help
-
Display help.
- -i, --build-info
-
Display build information and exit.
- -l, --license
-
Display WeeChat license.
- -p, --no-plugin
-
Disable plugins auto-load.
- -P, --plugins <plugins>
-
Load only these plugins at startup (see /help weechat.plugin.autoload). If this option is given, the option weechat.plugin.autoload is not used.
- -r, --run-command <command>
-
Run command(s) after startup; many commands can be separated by semicolons, this option can be given multiple times.
- -s, --no-script
-
Disable scripts auto-load.
- --upgrade
-
Upgrade WeeChat using session files generated with command
/upgrade -quit
. - -v, --version
-
Display WeeChat version.
- plugin:option
-
Option for a plugin.
Some extra options are available for debug purposes only:
Caution
|
Do NOT use any of these options in production! |
- --no-dlclose
-
Do not call the function dlclose after plugins are unloaded. This is useful with tools like Valgrind to display stack for unloaded plugins.
- --no-gnutls
-
Do not call the init and deinit functions of GnuTLS library. This is useful with tools like Valgrind and electric-fence, to prevent GnuTLS memory errors.
- --no-gcrypt
-
Do not call the init and deinit functions of Gcrypt library. This is useful with tools like Valgrind, to prevent Gcrypt memory errors.
3.2. Environment variables
Some environment variables are used by WeeChat if they are defined:
Name | Description |
---|---|
|
The WeeChat home (with configuration files, logs, scripts, etc.). Same behavior as CMake option |
|
The passphrase used to decrypt secured data. |
|
An extra directory to load plugins (from the "plugins" directory in this path). |
3.3. Colors support
WeeChat can use up to 32767 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 |
---|---|---|
"rxvt-unicode", "xterm", … |
88 |
32767 |
"rxvt-256color", "xterm-256color", … |
256 |
32767 |
"screen" |
8 |
64 |
"screen-256color" |
256 |
32767 |
"tmux" |
8 |
64 |
"tmux-256color" |
256 |
32767 |
You can run weechat --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
-
under tmux: screen-256color or tmux-256color
-
outside screen/tmux: 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, you can change it with these two commands:
/set env TERM screen-256color /upgrade
3.4. Files and directories
XDG directories
WeeChat uses XDG directories by default (according to the
XDG Base Directory Specification ↗).
A single home directory for all files can be forced by CMake option WEECHAT_HOME
,
the environment variable WEECHAT_HOME
or the command-line option -d
/ --dir
.
When a single WeeChat home directory is not forced, XDG directories are used and set like this:
Directory | Default value | Fallback value if $XDG_XXX is not defined |
---|---|---|
config |
|
|
data |
|
|
cache |
|
|
runtime |
|
Same as cache directory |
The configuration files are created with default values the first time you run WeeChat.
WeeChat directories
The WeeChat directories are:
Path (1) | Description |
---|---|
|
WeeChat configuration files: |
|
WeeChat data files: logs, scripts, scripts data, xfer files, etc. |
|
Log files (one file per buffer). |
|
Python scripts. |
|
Python scripts auto-loaded on startup (2). |
|
Perl scripts. |
|
Perl scripts auto-loaded on startup (2). |
|
Ruby scripts. |
|
Ruby scripts auto-loaded on startup (2). |
|
Lua scripts. |
|
Lua scripts auto-loaded on startup (2). |
|
Tcl scripts. |
|
Tcl scripts auto-loaded on startup (2). |
|
Guile scripts. |
|
Guile scripts auto-loaded on startup (2). |
|
JavaScript scripts. |
|
JavaScript scripts auto-loaded on startup (2). |
|
PHP scripts. |
|
PHP scripts auto-loaded on startup (2). |
|
WeeChat cache files: scripts cache. |
|
WeeChat runtime files: FIFO pipe, Relay UNIX sockets. |
Note
|
(1) XDG directories may be different according to your environment variables XDG_* .(2) This directory often contains only symbolic links to scripts in the parent directory. |
WeeChat files
The files in the WeeChat home directory are:
File | Description | Sensitive data |
---|---|---|
|
Main WeeChat configuration file |
Possible (example: list of channels in a saved buffers layout). |
|
Configuration file with secured data |
Yes, highly sensitive: this file must never be shared with anyone. |
|
Plugins configuration file |
Possible, depends on plugins/scripts. |
|
Configuration file for alias plugin |
Possible, depends on aliases. |
|
Configuration file for buflist plugin |
No. |
|
Configuration file for charset plugin |
No. |
|
Configuration file for exec plugin |
No. |
|
Configuration file for fifo plugin |
No. |
|
Configuration file for fset plugin |
No. |
|
Configuration file for guile plugin |
No. |
|
Configuration file for irc plugin |
Yes: it can contain passwords for servers, nickserv and channels (if not stored in |
|
Configuration file for javascript plugin |
No. |
|
Configuration file for logger plugin |
No. |
|
Configuration file for lua plugin |
No. |
|
Configuration file for perl plugin |
No. |
|
Configuration file for php plugin |
No. |
|
Configuration file for python plugin |
No. |
|
Configuration file for relay plugin |
Yes: it can contain relay password and TOTP secret (if not stored in |
|
Configuration file for ruby plugin |
No. |
|
Configuration file for script plugin |
No. |
|
Configuration file for tcl plugin |
No. |
|
Configuration file for spell plugin |
No. |
|
Configuration file for trigger plugin |
Possible, depends on triggers. |
|
Configuration file for typing plugin |
No. |
|
Configuration file for xfer plugin |
No. |
|
WeeChat log file |
No. |
Important
|
It is not recommended to edit configuration files by hand because WeeChat
may write them at any time (for example on /quit)
and after any change you must run the command /reload
(with the risk of losing other changes that were not yet saved with
/save). You can use the command /set, which checks the value and applies immediately the changes. |
4. Upgrade
If a new stable version of WeeChat is released, this is time for you to switch to this version.
First of all, you must install the new version of WeeChat, either with your
package manager or by compiling yourself, so that the weechat
binary and all
required files are in the same paths.
This can be done while WeeChat is running.
4.1. Upgrade command
WeeChat can restart the new binary, in place, using the
/upgrade command: the buffer contents and non-TLS
connections are preserved.
The TLS connections are lost during upgrade and are restored automatically
after the upgrade (reload of TLS sessions is currently not possible
with GnuTLS).
The command can also be used if you have to restart the machine, for example to upgrade the kernel or to move your WeeChat to another machine:
/upgrade -quit
This saves the current state in *.upgrade
files. You can then either reboot
or move the whole WeeChat directories (config, data, cache) to another machine,
and restart WeeChat later with this command:
weechat --upgrade
4.2. Restart after upgrade
Upgrading notes
After an upgrade, it is strongly recommended to read the file UPGRADING.md ↗ which contains important information about breaking changes and some manual actions that could be required.
You must read the versions between your old (excluded) and your new version (included).
For example if you switch from version 4.0.0 to 4.3.0, you must read versions
4.0.1 to 4.3.0.
Configuration upgrade
WeeChat has an automatic upgrade of configuration files (*.conf
):
-
new options are silently added with default value
-
obsolete options are automatically discarded and WeeChat displays a warning with the value read from file.
Example of warning when an option has been removed:
=!= Warning: /home/user/.config/weechat/sec.conf, line 15: unknown option for section "crypt": passphrase_file = ""
That means the option sec.crypt.passphrase_file
has been removed, and you
had value set to empty string, which was the default value in the previous version
(in this case no manual action is required).
5. Interface
5.1. Screen layout
Example of terminal with WeeChat:
▼ bar "buflist" ▼ bar "title" ┌──────────────────────────────────────────────────────────────────────────────────────┐ │1.libera │Welcome to #test, this is a test channel │ │ weechat│12:52:27 --> | Flashy (flashcode@weechat.org) has joined #test │@Flashy│ │2. #test│12:52:27 -- | Nicks #test: [@Flashy @joe +weebot peter] │@joe │ │3. #abc │12:52:27 -- | Channel #test: 4 nicks (2 ops, 1 voice, 1 normal) │+weebot│ │4. #def │12:52:27 -- | Channel created on Tue Jan 27 06:30:17 2009 │peter │ │5. #ghi │12:54:15 peter | hey! │ │ │ │12:55:01 @joe | hello │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 2:#test(+n){4}* M [H: 3:#abc(2,5), 5] │ │ │[@Flashy(i)] hi peter!█ │ └──────────────────────────────────────────────────────────────────────────────────────┘ ▲ bars "status" and "input" bar "nicklist" ▲
By default, the screen is divided up into the 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:
-
buflist bar, on the left
-
title bar, above chat area
-
status bar, below chat area
-
input bar, below status bar
-
nicklist bar, on the right
-
Bar buflist has following default items:
Item | Example | Description |
---|---|---|
buflist |
|
List of buffers. |
Bar title has following default items:
Item | Example | Description |
---|---|---|
buffer_title |
|
Buffer title. |
Bar status has following default items:
Item | Example | Description |
---|---|---|
time |
|
Time. |
buffer_last_number |
|
Number of the latest buffer (can be different from |
buffer_plugin |
|
Plugin of current buffer (irc plugin can add IRC server name used by buffer). |
buffer_number |
|
Current buffer number. |
buffer_name |
|
Current buffer name. |
buffer_modes |
|
IRC channel modes. |
buffer_nicklist_count |
|
Number of nicks displayed in nicklist. |
buffer_zoom |
! |
|
buffer_filter |
|
Filtering indicator: |
mouse_status |
|
Mouse status (empty if mouse is disabled), see command /mouse and toggle keys. |
scroll |
|
Scroll indicator, with number of lines below last line displayed. |
lag |
|
Lag indicator, in seconds (hidden if lag is low). |
hotlist |
|
List of buffers with activity (unread messages) (in example, 2 highlights and 5 unread messages on #abc, one unread message on buffer #5). |
typing |
|
Typing notification, see typing notifications. |
completion |
|
List of words for completion, with number of possible completions for each word. |
Bar input has following default items:
Item | Example | Description |
---|---|---|
input_prompt |
|
Input prompt, for irc: nick and modes (mode "+i" means invisible on libera). |
away |
|
Away indicator. |
input_search |
|
Search indicator (see below) |
input_paste |
|
Question to user for pasting lines. |
input_text |
|
Input text. |
There are two search modes:
-
search in lines, for example
[Search lines (~ str,msg)]
, with the following info:-
~
: case-insensitive -
==
: case-sensitive -
str
: search string -
regex
: search regular expression -
msg
: search in messages -
pre
: search in prefixes -
pre\|msg
: search in prefixes and messages.
-
-
search in commands history, for example
[Search command (~ str,local)]
, with the following info:-
~
: case-insensitive -
==
: case-sensitive -
str
: search string -
regex
: search regular expression -
local
: search in buffer local history -
global
: search in global history.
-
Bar nicklist has following default items:
Item | Example | Description |
---|---|---|
buffer_nicklist |
|
List of nicks on current buffer. |
Other items available (not used in bars by default):
Item | Example | Description |
---|---|---|
buffer_count |
|
Total number of buffers opened. |
buffer_nicklist_count_all |
|
Number of visible groups and nicks in nicklist. |
buffer_nicklist_count_groups |
|
Number of visible groups in nicklist. |
buffer_short_name |
|
Current buffer short name. |
buflist2 |
|
List of buffers, second bar item (see option buflist.look.use_items). |
buflist3 |
|
List of buffers, third bar item (see option buflist.look.use_items). |
buflist4 |
|
List of buffers, fourth bar item (see option buflist.look.use_items). |
buflist5 |
|
List of buffers, fifth bar item (see option buflist.look.use_items). |
fset |
|
Help on currently selected option on fset buffer. |
irc_channel |
|
Current IRC channel name. |
irc_host |
|
Current IRC host. |
irc_nick |
|
Current IRC nick. |
irc_nick_host |
|
Current IRC nick and host. |
irc_nick_modes |
|
IRC modes for self nick. |
irc_nick_prefix |
|
IRC nick prefix on channel. |
spacer |
Special item used to align text in bars, see Spacer item. |
|
spell_dict |
|
Spelling dictionaries used on current buffer. |
spell_suggest |
|
Spelling suggestions for word under cursor (if misspelled). |
tls_version |
|
TLS version in use for current IRC server. |
window_number |
|
Current window number. |
5.2. Command line
WeeChat command line (at the bottom of window) lets you execute commands or send text to buffer.
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
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):
Key | Description |
---|---|
Ctrl+c, b |
Bold text. |
Ctrl+c, c, xx |
Text color |
Ctrl+c, c, xx, ,, yy |
Text color |
Ctrl+c, d, xxxxxx |
Text color |
Ctrl+c, d, xxxxxx, ,, yyyyyy |
Text color |
Ctrl+c, i |
Italic text. |
Ctrl+c, o |
Disable color and attributes. |
Ctrl+c, v |
Reverse video (revert text color with background). |
Ctrl+c, _ |
Underlined text. |
Note
|
The same code (without number for Ctrl+c, c and Ctrl+c, d) can be used to stop the attribute. |
Color codes for Ctrl+c, c are:
IRC color | WeeChat color |
---|---|
|
white |
|
black |
|
blue |
|
green |
|
lightred |
|
red |
|
magenta |
|
brown |
|
yellow |
|
lightgreen |
|
cyan |
|
lightcyan |
|
lightblue |
|
lightmagenta |
|
darkgray |
|
gray |
|
52 |
|
94 |
|
100 |
|
58 |
|
22 |
|
29 |
|
23 |
|
24 |
|
17 |
|
54 |
|
53 |
|
89 |
|
88 |
|
130 |
|
142 |
|
64 |
|
28 |
|
35 |
|
30 |
|
25 |
|
18 |
|
91 |
|
90 |
|
125 |
|
124 |
|
166 |
|
184 |
|
106 |
|
34 |
|
49 |
|
37 |
|
33 |
|
19 |
|
129 |
|
127 |
|
161 |
|
196 |
|
208 |
|
226 |
|
154 |
|
46 |
|
86 |
|
51 |
|
75 |
|
21 |
|
171 |
|
201 |
|
198 |
|
203 |
|
215 |
|
227 |
|
191 |
|
83 |
|
122 |
|
87 |
|
111 |
|
63 |
|
177 |
|
207 |
|
205 |
|
217 |
|
223 |
|
229 |
|
193 |
|
157 |
|
158 |
|
159 |
|
153 |
|
147 |
|
183 |
|
219 |
|
212 |
|
16 |
|
233 |
|
235 |
|
237 |
|
239 |
|
241 |
|
244 |
|
247 |
|
250 |
|
254 |
|
231 |
|
default |
Note
|
To show all available colors in your terminal, you can do /color then
Alt+c in WeeChat or run this command in terminal: weechat --colors .
|
Example: display of "hello Alice!" with "hello" in light blue bold and "Alice" in light red underlined:
^Cc12^Cbhello ^Cb^Cc04^C_Alice^C_^Cc!
Keys:
Ctrl+c c 1 2 Ctrl+c b
h e l l o Space
Ctrl+c b Ctrl+c c 0 4 Ctrl+c _
A l i c e
Ctrl+c _ Ctrl+c c
!
Note
|
In irc plugin, you can remap these colors using option irc.color.mirc_remap. |
5.3. Buffers and windows
A buffer is composed by a number, a name, lines displayed (and some other data).
Examples of buffers:
-
core buffer (created by WeeChat on startup, cannot be closed)
-
irc server (displays messages from server)
-
irc channel
-
irc private messages
A window is a screen area which displays a buffer. It is possible to split your screen into many windows (examples below, see the /window command for details).
Each window displays one buffer. A buffer can be hidden (not displayed by a window) or displayed by one or more windows.
Screen layouts and the association between windows and buffers can be saved and restored.
Examples
Example of horizontal split (/window splith
):
▼ window #2 (buffer #4) ┌──────────────────────────────────────────────────────────────────────────────────────┐ │1.libera │Welcome to #def │ │ weechat│12:55:12 Max | hi │@Flashy│ │2. #test│12:55:20 @Flashy | hi Max! │Max │ │3. #abc │ │ │ │4. #def │ │ │ │5. #ghi │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 4:#def(+n){2} │ │ │[@Flashy] │ │ │────────────────────────────────────────────────────────────────────────────│ │ │Welcome to #abc │ │ │12:54:15 peter | hey! │@Flashy│ │ │12:55:01 @joe | hello │@joe │ │ │ │+weebot│ │ │ │peter │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 3:#abc(+n){4} │ │ │[@Flashy] hi peter!█ │ └──────────────────────────────────────────────────────────────────────────────────────┘ ▲ window #1 (buffer #3)
Example of vertical split (/window splitv
):
┌──────────────────────────────────────────────────────────────────────────────────────┐ │1.libera │Welcome to #abc │Welcome to #def │ │ weechat│12:54:15 peter | hey! │@Flashy│12:55:12 Max | hi │@Flashy│ │2. #test│12:55:01 @joe | hello │@joe │12:55:20 @Flashy | hi Max! │Max │ │3. #abc │ │+weebot│ │ │ │4. #def │ │peter │ │ │ │5. #ghi │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 3:#abc(+n) │[12:55] [5] [irc/libera] 4:#def(+n) │ │ │[@Flashy] hi peter!█ │[@Flashy] │ └──────────────────────────────────────────────────────────────────────────────────────┘ ▲ window #1 (buffer #3) ▲ window #2 (buffer #4)
Example of vertical + horizontal splits:
▼ window #3 (buffer #5) ┌──────────────────────────────────────────────────────────────────────────────────────┐ │1.libera │Welcome to #abc │Welcome to #ghi │ │ weechat│12:54:15 peter | hey! │@Flashy│12:55:42 @Flashy | hi │@Flashy│ │2. #test│12:55:01 @joe | hello │@joe │12:55:56 alex | hi Flashy │alex │ │3. #abc │ │+weebot│ │ │ │4. #def │ │peter │ │ │ │5. #ghi │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 5:#ghi(+n) │ │ │ │ │[@Flashy] │ │ │ │ │──────────────────────────────────────│ │ │ │ │Welcome to #def │ │ │ │ │12:55:12 Max | hi │@Flashy│ │ │ │ │12:55:20 @Flashy | hi Max! │Max │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 3:#abc(+n) │[12:55] [5] [irc/libera] 4:#def(+n) │ │ │[@Flashy] hi peter!█ │[@Flashy] │ └──────────────────────────────────────────────────────────────────────────────────────┘ ▲ window #1 (buffer #3) ▲ window #2 (buffer #4)
Bare display
A special display, called "bare display" can be used for easy click on long URLs and selection of text (using the mouse).
The bare display has following features:
-
It displays only the content of current buffer: no window split neither bars (no title, nicklist, status, input, …).
-
The WeeChat mouse support is disabled (if it was enabled): you can use your mouse like you do in the terminal to click on URLs and select text.
-
Ncurses is not used, therefore URLs are not cut at the end of lines.
The default key to enable bare display is Alt+l (L
), and same key to exit
(or by default anything changing the input will exit the bare display, see option
weechat.look.bare_display_exit_on_input).
The time format can be customized with the option weechat.look.bare_display_time_format.
The bare display can be enabled for a specific delay using the command /window.
If WeeChat looks like that:
┌──────────────────────────────────────────────────────────────────────────────────────┐ │1.libera │Welcome to #abc │ │ weechat│12:52:27 --> | Flashy (flashcode@weechat.org) has joined #abc │@Flashy│ │2. #test│12:52:27 -- | Nicks #abc: [@Flashy @joe +weebot peter] │@joe │ │3. #abc │12:52:27 -- | Channel #abc: 4 nicks (2 ops, 1 voice, 1 normal) │+weebot│ │4. #def │12:52:27 -- | Channel created on Tue Jan 27 06:30:17 2009 │peter │ │5. #ghi │12:54:15 peter | hey! │ │ │ │12:55:01 @joe | peter: hook_process: https://weechat.org/files/doc │ │ │ │ | /weechat/devel/weechat_plugin_api.en.html#_weechat │ │ │ │ | _hook_process │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │[12:55] [5] [irc/libera] 3:#abc(+n){4} │ │ │[@Flashy(i)] hi peter!█ │ └──────────────────────────────────────────────────────────────────────────────────────┘
The screen will look like that in bare display:
┌──────────────────────────────────────────────────────────────────────────────────────┐ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │12:52 --> Flashy (flashcode@weechat.org) has joined #abc │ │12:52 -- Nicks #abc: [@Flashy @joe +weebot peter] │ │12:52 -- Channel #abc: 4 nicks (2 ops, 1 voice, 1 normal) │ │12:52 -- Channel created on Tue Jan 27 06:30:17 2009 │ │12:54 <peter> hey! │ │12:55 <@joe> peter: hook_process: https://weechat.org/files/doc/weechat/devel/weechat_│ │plugin_api.en.html#_weechat_hook_process │ └──────────────────────────────────────────────────────────────────────────────────────┘
So you can click the URL from joe without any problem in your terminal (of course this supposes that your terminal supports click on URLs).
5.4. Buffers
Format of lines
Lines displayed in formatted buffers have following fields:
Field | Displayed | Description |
---|---|---|
date/time (message) |
Yes |
Date/time of message (may be past). |
date/time (print) |
No |
Date/time when WeeChat prints the message. |
prefix |
Yes |
Prefix of message, commonly a nick. |
message |
Yes |
The message itself. |
displayed |
No |
Boolean: true if line is displayed, false if line is filtered with command /filter. |
highlight |
No |
Boolean: true if line has a highlight, false otherwise. |
tags |
With |
Tags associated with the line (see lines tags). |
The display of lines can be customized with many look options (weechat.look.*) and color options (weechat.color.chat_*).
Lines tags
WeeChat uses tags in lines for different purposes:
-
highlight
-
notify level
-
logging
-
use of command /filter
Tags can be displayed with the command /debug tags
(same command to hide them).
Tags commonly used (non-exhaustive list):
Tag | Description |
---|---|
|
Line cannot be filtered. |
|
No highlight is possible on line. |
|
Line is not written in log file. |
|
Level of log for line (see the /logger command). |
|
The line must not be added to hotlist. (1) |
|
The line is a user message. (1) |
|
The line is a private message. (1) |
|
The line is a message with highlight. (1) |
|
Self message. |
|
Message is from nick "xxx". |
|
Prefix is a nick with color "ccc". |
|
Username and host in message. |
|
IRC message "xxx" (can be a command or a 3-digits number). |
|
IRC numeric message. |
|
Error from IRC server. |
|
Action from a nick (command |
|
CTCP message. |
|
Reply to CTCP message. |
|
IRC message that can be filtered with the "smart filter". |
|
Message with away info. |
Note
|
(1) When no tag "notify_xxx" is present, the default level is "low". If a tag "notify_xxx" is present, the real notify level can be different, for example if a max hotlist level is used for a nick, the notify level can be lower than the value in the tag. |
Local variables
Local variables can be defined in all buffers.
A local variable has:
-
a name (string)
-
a value (string, can be empty).
Local variables can be set by WeeChat, plugins, scripts, or manually on the command line in the buffer.
For example to add the local variable "completion_default_template":
/buffer setvar completion_default_template %(my_completion)
To list local variables in the current buffer:
/buffer listvar
To remove the local variable "completion_default_template":
/buffer delvar completion_default_template
By default WeeChat and its default plugins interpret these variables:
Name | Value | Description |
---|---|---|
|
any string |
Away message on the server, set by irc plugin. |
|
any string |
Channel name, set by irc/xfer plugins and debug buffer of relay/trigger plugins. |
|
any string |
Charset modifier for the server buffer, set by irc plugin. |
|
any string |
Default completion template for the buffer, overriding the option
|
|
any string |
Filter defined on some buffers like |
|
any string |
Self host (if known), set by irc plugin. |
|
any string |
Lag on the server, set by irc plugin. |
|
any string |
Buffer name (be careful, this is not the full name and this name is not enough to identify or search a buffer). |
|
any string |
Self nick, set by irc and xfer plugins. |
|
|
If set, the logger plugin does not log anything for the buffer. |
|
any string |
Name of plugin which created the buffer ( |
|
any string |
Close callback defined by a script for a buffer. |
|
any string |
Data for close callback defined by a script for a buffer. |
|
any string |
Input callback defined by a script for a buffer. |
|
any string |
Data for input callback defined by a script for a buffer. |
|
any string |
Name of the script which created the buffer. |
|
any string |
Server name, set by irc plugin and debug buffer of relay/trigger plugins. |
|
any string |
Misspelled word and suggestions (format: "misspelled:suggestions"), set by spell plugin. |
|
any string |
Trigger filter, set by trigger plugin. |
|
any string, for example:
|
Type of buffer, set by WeeChat and many plugins. |
Note
|
External plugins and scripts can define and use other local variables. |
5.5. List of buffers
Buflist plugin displays a list of buffers in a bar item called "buflist"
(four other bar items "buflist2", "buflist3", "buflist4" and "buflist5" are
available as well).
A default bar "buflist" is created on startup with this item.
Commands
-
buflist
: bar item with list of buffers
/buflist enable|disable|toggle bar refresh [<item>[,<item>...]] enable: enable buflist disable: disable buflist toggle: toggle buflist bar: add the "buflist" bar refresh: force the refresh of some bar items (if no item is given, all bar items used are refreshed, according to option buflist.look.use_items) The lines with buffers are displayed using string evaluation (see /help eval for the format), with these options: - buflist.look.display_conditions: conditions to display a buffer in the list - buflist.format.buffer: format for a buffer which is not current buffer - buflist.format.buffer_current: format for the current buffer The following variables can be used in these options: - bar item data (see hdata "bar_item" in API doc for a complete list), for example: - ${bar_item.name} - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example: - ${window.number} - ${window.buffer.full_name} - buffer data (see hdata "buffer" in API doc for a complete list), for example: - ${buffer.number} - ${buffer.name} - ${buffer.full_name} - ${buffer.short_name} - ${buffer.nicklist_nicks_count} - irc_server: IRC server data, defined only on an IRC buffer (see hdata "irc_server" in API doc) - irc_channel: IRC channel data, defined only on an IRC channel buffer (see hdata "irc_channel" in API doc) - extra variables added by buflist for convenience: - ${format_buffer}: the evaluated value of option buflist.format.buffer; this can be used in option buflist.format.buffer_current to just change the background color for example - ${current_buffer}: a boolean ("0" or "1"), "1" if this is the current buffer; it can be used in a condition: ${if:${current_buffer}?...:...} - ${merged}: a boolean ("0" or "1"), "1" if the buffer is merged with at least another buffer; it can be used in a condition: ${if:${merged}?...:...} - ${format_number}: indented number with separator (evaluation of option buflist.format.number) - ${number}: indented number, for example " 1" if there are between 10 and 99 buffers; for merged buffers, this variable is set with number for the first buffer and spaces for the next buffers with same number - ${number2}: indented number, for example " 1" if there are between 10 and 99 buffers - ${number_displayed}: "1" if the number is displayed, otherwise "0" - ${indent}: indentation for name (channel, private and list buffers are indented) (evaluation of option buflist.format.indent) - ${format_nick_prefix}: colored nick prefix for a channel (evaluation of option buflist.format.nick_prefix) - ${color_nick_prefix}: color of nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled) - ${nick_prefix}: nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled) - ${format_name}: formatted name (evaluation of option buflist.format.name) - ${name}: the short name (if set), with a fallback on the name - ${color_hotlist}: the color depending on the highest hotlist level for the buffer (evaluation of option buflist.format.hotlist_xxx where xxx is the level) - ${format_hotlist}: the formatted hotlist (evaluation of option buflist.format.hotlist) - ${hotlist}: the raw hotlist - ${hotlist_priority}: "none", "low", "message", "private" or "highlight" - ${hotlist_priority_number}: -1 = none, 0 = low, 1 = message, 2 = private, 3 = highlight - ${format_lag}: the lag for an IRC server buffer, empty if there's no lag (evaluation of option buflist.format.lag) - ${format_tls_version}: indicator of TLS version for a server buffer, empty for channels (evaluation of option buflist.format.tls_version)
Options
Sections in file buflist.conf:
Section | Control command | Description |
---|---|---|
|
|
Formats used to display list of buffers. |
|
|
Look and feel. |
Options:
-
-
description: format of each line with a buffer (note: content is evaluated, see /help buflist); example: standard format for bar item "buflist" and only the buffer number between square brackets for other bar items ("buflist2" to "buflist5"): "${if:${bar_item.name}==buflist?${format_number}${indent}${format_nick_prefix}${color_hotlist}${format_name}:[${number}]}"
-
type: string
-
values: any string
-
default value:
"${format_number}${indent}${format_nick_prefix}${color_hotlist}${format_name}"
-
-
-
description: format for the line with current buffer (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:,17}${format_buffer}"
-
-
-
description: format for hotlist (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
" ${color:green}(${hotlist}${color:green})"
-
-
buflist.format.hotlist_highlight
-
description: format for a buffer with hotlist level "highlight" (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:magenta}"
-
-
-
description: format for a buffer with hotlist level "low" (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:white}"
-
-
buflist.format.hotlist_message
-
description: format for a buffer with hotlist level "message" (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:brown}"
-
-
-
description: format for a buffer not in hotlist (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:default}"
-
-
buflist.format.hotlist_private
-
description: format for a buffer with hotlist level "private" (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:green}"
-
-
buflist.format.hotlist_separator
-
description: separator for counts in hotlist (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:default},"
-
-
-
description: string displayed to indent channel, private and list buffers (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
" "
-
-
-
description: format for lag on an IRC server buffer (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
" ${color:green}[${color:brown}${lag}${color:green}]"
-
-
-
description: format for buffer name (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${name}"
-
-
-
description: format for nick prefix on a channel (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color_nick_prefix}${nick_prefix}"
-
-
-
description: format for buffer number, ${number} is the indented number (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
"${color:green}${number}${if:${number_displayed}?.: }"
-
-
-
description: format for TLS version on an IRC server buffer (note: content is evaluated, see /help buflist)
-
type: string
-
values: any string
-
default value:
" ${color:default}(${if:${tls_version}==TLS1.3?${color:green}:${if:${tls_version}==TLS1.2?${color:yellow}:${color:red}}}${translate:${tls_version}}${color:default})"
-
-
-
description: add newline between the buffers displayed, so each buffer is displayed on a separate line (recommended); if disabled, newlines must be manually added in the formats with "${\n}", and the mouse actions are not possible anymore
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: automatically scroll the buflist bar to always see the current buffer (this works only with a bar on the left/right position with a "vertical" filling); this value is the percent number of lines displayed before the current buffer when scrolling (-1 = disable scroll); for example 50 means that after a scroll, the current buffer is at the middle of bar, 0 means on top of bar, 100 means at bottom of bar
-
type: integer
-
values: -1 .. 100
-
default value:
50
-
-
buflist.look.display_conditions
-
description: conditions to display a buffer (note: content is evaluated, see /help buflist); for example to hide server buffers if they are merged with core buffer: "${buffer.hidden}==0 && ((${type}!=server && ${buffer.full_name}!=core.weechat) || ${buffer.active}==1)"
-
type: string
-
values: any string
-
default value:
"${buffer.hidden}==0"
-
-
-
description: enable buflist; it is recommended to use this option instead of just hiding the bar because it also removes some internal hooks that are not needed anymore when the bar is hidden; you can also use the command "/buflist toggle" or use the default key alt+shift+b
-
type: boolean
-
values: on, off
-
default value:
on
-
-
buflist.look.mouse_jump_visited_buffer
-
description: if enabled, clicks with left/right buttons on the line with current buffer jump to previous/next visited buffer
-
type: boolean
-
values: on, off
-
default value:
off
-
-
buflist.look.mouse_move_buffer
-
description: if enabled, mouse gestures (drag & drop) move buffers in list
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: if enabled, mouse wheel up/down actions jump to previous/next buffer in list
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: get the nick prefix and its color from nicklist so that ${nick_prefix} can be used in format; this can be slow on buffers with lot of nicks in nicklist, so this option is disabled by default
-
type: boolean
-
values: on, off
-
default value:
off
-
-
buflist.look.nick_prefix_empty
-
description: when the nick prefix is enabled, display a space instead if there is no nick prefix on the buffer
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: comma-separated list of extra signals that are hooked and trigger the refresh of buffers list; this can be useful if some custom variables are used in formats and need specific refresh
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: comma-separated list of fields to sort buffers; each field is a hdata variable of buffer ("var"), a hdata variable of IRC server ("irc_server.var") or a hdata variable of IRC channel ("irc_channel.var"); char "-" can be used before field to reverse order, char "~" can be used to do a case-insensitive comparison; examples: "-~short_name" for case-insensitive and reverse sort on buffer short name, "-hotlist.priority,hotlist.time,hotlist.time_usec,number,-active" for sort like the hotlist then by buffer number for buffers without activity (note: the content is evaluated, before being split into fields, but at that time "bar_item" is the only variable that can be used, to distinguish between different buflist items, for example "${bar_item.name}")
-
type: string
-
values: any string
-
default value:
"number,-active"
-
-
-
description: number of buflist bar items that can be used; the item names are: "buflist", "buflist2", "buflist3", "buflist4" and "buflist5"; be careful, using more than one bar item slows down the display of buffers list
-
type: integer
-
values: 1 .. 5
-
default value:
1
-
5.6. Cursor mode
The cursor mode allows you to move freely the cursor anywhere on screen, in chat
area and bars, and lets you perform actions at the given position.
You can enter in cursor mode either with the command /cursor
or with a mouse
middle click (mouse must have been enabled with key Alt+m or command
/mouse enable
).
Typical use is to quote messages (chat area) or interact with nicks (nicklist bar).
See command /cursor and key bindings in cursor context for the list of actions you can perform in this mode.
6. Key bindings
WeeChat provides a lot of default key bindings, listed in the following chapters.
They can be changed and new ones can be added with the /key command.
6.1. Command line
Cursor movement
Key | Description | Command |
---|---|---|
← |
Go to previous char in command line. |
|
→ |
Go to next char in command line. |
|
Shift+↑ |
Go to previous line. |
|
Shift+↓ |
Go to next line. |
|
Ctrl+← |
Go to previous word in command line. |
|
Ctrl+→ |
Go to next word in command line. |
|
Home |
Go to the beginning of current line. |
|
Shift+Home |
Go to the beginning of command line. |
|
End |
Go to the end of current line. |
|
Shift+End |
Go to the end of command line. |
|
Editing
Key | Description | Command |
---|---|---|
Del |
Delete next char in command line. |
|
Backspace |
Delete previous char in command line. |
|
Ctrl+k |
Delete from cursor until end of current line (deleted string is copied to the internal clipboard). |
|
Alt+Ctrl+k |
Delete from cursor until end of command line (deleted string is copied to the internal clipboard). |
|
Ctrl+t |
Transpose chars. |
|
Ctrl+u |
Delete from cursor until beginning of current line (deleted string is copied to the internal clipboard). |
|
Alt+Ctrl+u |
Delete from cursor until beginning of command line (deleted string is copied to the internal clipboard). |
|
Alt+Backspace |
Delete previous word of command line (deleted string is copied to the internal clipboard). |
|
Ctrl+w |
Delete previous word of command line until whitespace (deleted string is copied to the internal clipboard). |
|
Ctrl+y |
Paste the internal clipboard content. |
|
Ctrl+_ |
Undo last action on command line. |
|
Alt+_ |
Redo last action on command line. |
|
Tab |
Complete command or nick (Tab again: find next completion). |
|
Shift+Tab |
Without completion: do a partial completion, with pending completion: complete with previous completion. |
|
Enter |
Execute command or send message (in search mode: stop search). |
|
Ctrl+o |
Execute the command found in history and insert the next one in the command line. |
|
Alt+Enter |
Insert a newline. |
|
Alt+d |
Delete next word in command line (deleted string is copied to the internal clipboard). |
|
Alt+k |
Grab a key and insert its code (and command bound if key exists) in command line. |
|
Alt+r |
Delete current line. |
|
Alt+R |
Delete entire command line. |
|
Color codes
Key | Description | Command |
---|---|---|
Ctrl+c, b |
Insert code for bold text. |
|
Ctrl+c, c |
Insert code for colored text. |
|
Ctrl+c, d |
Insert code for colored text (RGB color, as hexadecimal). |
|
Ctrl+c, i |
Insert code for italic text. |
|
Ctrl+c, o |
Insert code for color reset. |
|
Ctrl+c, v |
Insert code for reverse color. |
|
Ctrl+c, _ |
Insert code for underlined text. |
|
Command history
Key | Description | Command |
---|---|---|
↑ |
Call previous command/message (in search mode: search up). |
|
↓ |
Call next command/message (in search mode: search down). |
|
Ctrl+↑ |
Call previous command/message in global history (common for all buffers). |
|
Ctrl+↓ |
Call next command/message in global history (common for all buffers). |
|
6.2. Buffers
Key | Description | Command |
---|---|---|
Ctrl+r |
Search for text in commands history (see keys for context "histsearch"). |
|
Ctrl+s |
Search for text in buffer lines (see keys for context "search"). |
|
Ctrl+x |
Switch current buffer if buffers are merged with same number, for example switch to another IRC server buffer. |
|
Alt+x |
Zoom on merged buffer (Alt+x again: display all merged buffers). |
|
PgUp |
Scroll up one page in buffer history. |
|
PgDn |
Scroll down one page in buffer history. |
|
Alt+PgUp |
Scroll up a few lines in buffer history. |
|
Alt+PgDn |
Scroll down a few lines in buffer history. |
|
Alt+Home |
Scroll to top of buffer. |
|
Alt+End |
Scroll to bottom of buffer. |
|
Alt+← |
Switch to previous buffer. |
|
Alt+→ |
Switch to next buffer. |
|
Alt+j, Alt+f |
Switch to first buffer. |
|
Alt+j, Alt+l ( |
Switch to last buffer. |
|
Alt+j, Alt+r |
Switch to IRC raw buffer. |
|
Alt+j, Alt+s |
Switch to IRC server buffer. |
|
Alt+0…9 |
Switch to buffer by number (0 = 10). |
|
Alt+j, 01…99 |
Switch to buffer by number. |
|
Alt+n |
Scroll to next highlight. |
|
Alt+p |
Scroll to previous highlight. |
|
Alt+u |
Scroll to first unread line in buffer. |
|
Alt+Shift+U |
Set unread marker on all buffers. |
|
Alt+< |
Switch to previous buffer in list of visited buffers. |
|
Alt+> |
Switch to next buffer in list of visited buffers. |
|
Alt+/ |
Switch to last buffer displayed (before last jump to a buffer). |
|
6.3. Windows
Key | Description | Command |
---|---|---|
Ctrl+l ( |
Redraw whole window. |
|
Alt+l ( |
Toggle bare display. |
|
F7 |
Switch to previous window. |
|
F8 |
Switch to next window. |
|
Alt+w, Alt+↑ |
Switch to window above. |
|
Alt+w, Alt+↓ |
Switch to window below. |
|
Alt+w, Alt+← |
Switch to window on the left. |
|
Alt+w, Alt+→ |
Switch to window on the right. |
|
Alt+w, Alt+b |
Balance the sizes of all windows. |
|
Alt+w, Alt+s |
Swap buffers of two windows. |
|
Alt+z |
Zoom on current window (Alt+z again: restore initial windows state, before zoom). |
|
6.4. Bars
Key | Description | Command |
---|---|---|
F1 |
Scroll up one page in buflist. |
|
F2 |
Scroll down one page in buflist. |
|
Alt+F1 |
Go to the beginning of buflist. |
|
Alt+F2 |
Go to the end of buflist. |
|
F9 |
Scroll buffer’s title on the left. |
|
F10 |
Scroll buffer’s title on the right. |
|
F11 |
Scroll up one page in nicklist. |
|
F12 |
Scroll down one page in nicklist. |
|
Alt+F11 |
Go to the beginning of nicklist. |
|
Alt+F12 |
Go to the end of nicklist. |
|
Alt+Shift+B |
Toggle buflist. |
|
Alt+Shift+N |
Toggle nicklist bar. |
|
6.5. Hotlist
Key | Description | Command |
---|---|---|
Alt+a |
Switch to next buffer with activity (with priority: highlight, message, other). |
|
Alt+h, Alt+c |
Clear hotlist (activity notification on buffers). |
|
Alt+h, Alt+m |
Remove current buffer from hotlist. |
|
Alt+h, Alt+r |
Restore latest hotlist removed in the current buffer. |
|
Alt+h, Alt+Shift+R |
Restore latest hotlist removed in all buffers. |
|
6.6. Toggle keys
Key | Description | Command |
---|---|---|
Alt+m |
Toggle mouse. |
|
Alt+s |
Toggle spell checker. |
|
Alt+= |
Toggle filters. |
|
Alt+- |
Toggle filters in current buffer. |
|
6.7. Search context
These keys are used in context "search" (when Ctrl+s is pressed to search text in buffer lines).
Key | Description | Command |
---|---|---|
Ctrl+x |
Switch search type: string (default), regular expression. |
|
Alt+c |
Switch exact case for search. |
|
Tab |
Switch search in: messages (default), prefixes, prefixes + messages. |
|
Ctrl+r |
Search previous line. |
|
Ctrl+s |
Search next line. |
|
Enter |
Stop search at current position. |
|
Ctrl+q |
Stop search and reset scroll to pre-text search state. |
|
6.8. History search context
These keys are used in context "histsearch" (when Ctrl+r is pressed to search text in commands history).
Key | Description | Command |
---|---|---|
Ctrl+x |
Switch search type: string (default), regular expression. |
|
Alt+c |
Switch exact case for search. |
|
Tab |
Switch search in: buffer local history (default), global history. |
|
Ctrl+r |
Search in previous (older) history entries. |
|
Ctrl+s |
Search in next (newer) history entries. |
|
Enter |
Stop search and use matching input. |
|
Ctrl+o |
Execute the command found in history and insert the next one in the command line. |
|
Ctrl+q |
Stop search and restore input to its initial value. |
|
6.9. Cursor context
These keys are used in context "cursor" (free movement of cursor on screen), see Cursor mode.
Key | Area | Description | Command |
---|---|---|---|
↑ |
- |
Move cursor one line up. |
|
↓ |
- |
Move cursor one line down. |
|
← |
- |
Move cursor one column left. |
|
→ |
- |
Move cursor one column right. |
|
Alt+↑ |
- |
Move cursor to the first line of the area. |
|
Alt+↓ |
- |
Move cursor to the last line of the area. |
|
Alt+← |
- |
Move cursor to the first column of the area. |
|
Alt+→ |
- |
Move cursor to the last column of the area. |
|
Alt+Home |
- |
Move cursor to the top left corner of the area. |
|
Alt+End |
- |
Move cursor to the bottom right corner of the area. |
|
Alt+Shift+↑ |
- |
Move cursor one area up. |
|
Alt+Shift+↓ |
- |
Move cursor one area down. |
|
Alt+Shift+← |
- |
Move cursor one area left. |
|
Alt+Shift+→ |
- |
Move cursor one area right. |
|
m |
chat |
Quote message. |
|
l |
chat |
Quote focused line. |
|
q |
chat |
Quote prefix + message. |
|
Q |
chat |
Quote time + prefix + message. |
|
b |
nicklist |
Ban nick. |
|
k |
nicklist |
Kick nick. |
|
K |
nicklist |
Kick and ban nick. |
|
q |
nicklist |
Open query with nick. |
|
w |
nicklist |
Do a whois on nick. |
|
Enter |
- |
Stop cursor mode |
|
6.10. Mouse
These mouse actions are possible only if mouse is enabled with key Alt+m
(command: /mouse toggle
).
Button/Wheel (1) | Gesture | Area | Description | Command |
---|---|---|---|---|
■ □ □ |
- |
chat |
Switch to window. |
|
■ □ □ |
left |
chat |
Switch to previous buffer. |
|
■ □ □ |
right |
chat |
Switch to next buffer. |
|
■ □ □ |
left (long) |
chat |
Switch to first buffer. |
|
■ □ □ |
right (long) |
chat |
Switch to last buffer. |
|
▲ |
- |
chat |
Scroll up a few lines in buffer history. |
|
▼ |
- |
chat |
Scroll down a few lines in buffer history. |
|
Ctrl+▲ |
- |
chat |
Scroll horizontally to the left. |
|
Ctrl+▼ |
- |
chat |
Scroll horizontally to the right. |
|
▲ |
- |
chat: fset buffer |
Move five lines up in fset buffer. |
|
▼ |
- |
chat: fset buffer |
Move five lines down in fset buffer. |
|
■ □ □ |
- |
chat: fset buffer |
Select line in fset buffer. |
|
□ □ ■ |
- |
chat: fset buffer |
Toggle boolean (on/off) or edit the option value. |
|
□ □ ■ |
left |
chat: fset buffer |
Decrease value for integer/color/enum, set/append to value for other types. |
|
□ □ ■ |
right |
chat: fset buffer |
Increase value for integer/color/enum, set/append to value for other types. |
|
□ □ ■ |
up / down |
chat: fset buffer |
Mark/unmark multiple options. |
|
▲ |
- |
chat: /list buffer |
Move five lines up in /list buffer. |
|
▼ |
- |
chat: /list buffer |
Move five lines down in /list buffer. |
|
■ □ □ |
- |
chat: /list buffer |
Select line in /list buffer. |
|
□ □ ■ |
- |
chat: /list buffer |
Join IRC channel on selected line. |
|
▲ |
- |
chat: script buffer |
Move five lines up in script buffer. |
|
▼ |
- |
chat: script buffer |
Move five lines down in script buffer. |
|
■ □ □ |
- |
chat: script buffer |
Select line in script buffer. |
|
□ □ ■ |
- |
chat: script buffer |
Install/remove script. |
|
■ □ □ |
up / left |
buflist |
Move buffer to a lower number. |
Signal |
■ □ □ |
down / right |
buflist |
Move buffer to a higher number. |
Signal |
■ □ □ |
- |
buflist |
Switch to buffer (previously visited buffer if the buffer is the current one). |
Signal |
□ □ ■ |
- |
buflist |
Switch to next visited buffer if the buffer is the current one. |
Signal |
Ctrl+▲ |
- |
buflist |
Switch to previous buffer. |
Signal |
Ctrl+▼ |
- |
buflist |
Switch to next buffer. |
Signal |
■ □ □ |
up |
nicklist |
Scroll up one page in nicklist. |
|
■ □ □ |
down |
nicklist |
Scroll down one page in nicklist. |
|
■ □ □ |
up (long) |
nicklist |
Go to the beginning of nicklist. |
|
■ □ □ |
down (long) |
nicklist |
Go to the end of nicklist. |
|
■ □ □ |
- |
nicklist |
Open query with nick. |
|
□ □ ■ |
- |
nicklist |
Do a whois on nick. |
|
■ □ □ |
left |
nicklist |
Kick nick. |
|
■ □ □ |
left (long) |
nicklist |
Kick and ban nick. |
|
□ □ ■ |
left |
nicklist |
Ban nick. |
|
□ □ ■ |
- |
input |
Grab a mouse event and insert its code in command line. |
|
▲ |
- |
any bar |
Scroll bar by -20%. |
|
▼ |
- |
any bar |
Scroll bar by +20%. |
|
□ ■ □ |
- |
anywhere |
Start cursor mode at this point. |
|
Note
|
(1) Buttons: ◼ □ □: click on left button □ ◼ □: click on middle button □ □ ◼: click on right button Wheel: ▲: wheel up ▼: wheel down |
6.11. Fset buffer
These keys and actions are used on the fset buffer (see Fset plugin).
Key | Action (1) | Description | Command |
---|---|---|---|
↑ |
Move one line up. |
|
|
↓ |
Move one line down. |
|
|
PgUp |
Move one page up. |
|
|
PgDn |
Move one page down. |
|
|
Alt+Home |
|
Move to first line. |
|
Alt+End |
|
Move to last line. |
|
F11 |
|
Scroll horizontally on the left. |
|
F12 |
|
Scroll horizontally on the right. |
|
Alt+Space |
|
Toggle boolean value. |
|
Alt+- |
|
Subtract 1 from value for integer/color/enum, set value for other types. |
|
Alt++ |
|
Add 1 to value for integer/color/enum, append to value for other types. |
|
Alt+f, Alt+r |
|
Reset value. |
|
Alt+f, Alt+u |
|
Unset value. |
|
Alt+Enter |
|
Set value. |
|
Alt+f, Alt+n |
|
Set new value. |
|
Alt+f, Alt+a |
|
Append to value. |
|
Alt+, |
|
Mark/unmark option. |
|
Shift+↑ |
Move one line up and mark/unmark option. |
|
|
Shift+↓ |
Mark/unmark option and move one line down. |
|
|
|
Mark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see /fset command). |
||
|
Unmark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see /fset command). |
||
Ctrl+l ( |
Refresh options and whole screen. |
|
|
|
Refresh options (keep marked options). |
||
|
Refresh options (unmark all options). |
||
Alt+p |
|
Toggle plugin description options ( |
|
Alt+v |
|
Toggle help bar. |
|
|
Sort options by fields x,y (see option fset.look.sort). |
|
|
|
Reset sort to its default value (see option fset.look.sort). |
|
|
|
Export options in file "xxx". |
|
|
|
Export options in file "xxx" without help. |
|
|
|
Export options in file "xxx" with help. |
|
|
Ctrl+x |
|
Switch the format used to display options. |
|
|
Close fset buffer. |
|
Note
|
(1) The action must be entered as input on the command line, followed by Enter. |
6.12. IRC /list buffer
These keys and actions are used on the IRC /list buffer (see command /list).
Key | Action (1) | Description | Command |
---|---|---|---|
↑ |
Move one line up. |
|
|
↓ |
Move one line down. |
|
|
PgUp |
Move one page up. |
|
|
PgDn |
Move one page down. |
|
|
Alt+Home |
|
Move to first line. |
|
Alt+End |
|
Move to last line. |
|
F11 |
|
Scroll horizontally on the left. |
|
F12 |
|
Scroll horizontally on the right. |
|
Ctrl+j |
|
Join IRC channel on selected line. |
|
|
Show only channels with "xxx" in name or topic (case-insensitive). |
||
|
Show only channels with "xxx" in name (case-insensitive). |
||
|
Show only channels with "xxx" in topic (case-insensitive). |
||
|
Show only channels with at least "n" users. |
||
|
Show only channels with more than "n" users. |
||
|
Show only channels with less than "n" users. |
||
|
Show only channels matching the evaluated condition "xxx", using following variables: name, name2, users, topic. |
||
|
Sort channels by fields x,y (see command /list). |
||
|
Reset sort to its default value (see command /list). |
||
|
Refresh list (run again command /list). |
||
|
Close buffer. |
|
Note
|
(1) The action must be entered as input on the command line, followed by Enter. |
6.13. Script buffer
These keys and actions are used on the script buffer (see script manager).
Key | Action (1) | Description | Command |
---|---|---|---|
↑ |
Move one line up. |
|
|
↓ |
Move one line down. |
|
|
PgUp |
Move one page up. |
|
|
PgDn |
Move one page down. |
|
|
Alt+i |
|
Install script. |
|
Alt+r |
|
Remove script. |
|
Alt+l |
|
Load script. |
|
Alt+L |
|
Reload script. |
|
Alt+u |
|
Unload script. |
|
Alt+Shift+A |
|
Autoload script. |
|
Alt+h |
|
Hold/unhold script. |
|
Alt+v |
|
View script. |
|
|
Sort scripts by fields x,y (see option script.look.sort). |
||
|
Reset sort to its default value (see option script.look.sort). |
||
|
Refresh list. |
||
|
Close buffer. |
|
Note
|
(1) The action must be entered as input on the command line, followed by Enter. |
7. Configuration
7.1. Fset
Fast Set plugin displays a list of options in a buffer, and helps to set WeeChat and plugin options.
Example of fset buffer displaying options starting with weechat.look
:
┌──────────────────────────────────────────────────────────────────────────────────────┐ │1.weechat│7/125 | Filter: weechat.look.* | Sort: ~name | Key(input): alt+space=toggl>>│ │2.fset │weechat.look.bare_display_exit_on_input: exit the bare display mode on any c│ │ │hanges in input [default: on] │ │ │----------------------------------------------------------------------------│ │ │ weechat.look.align_end_of_lines enum message │ │ │ weechat.look.align_multiline_words boolean on │ │ │ weechat.look.bar_more_down string "++" │ │ │ weechat.look.bar_more_left string "<<" │ │ │ weechat.look.bar_more_right string ">>" │ │ │ weechat.look.bar_more_up string "--" │ │ │ weechat.look.bare_display_exit_on_input boolean on │ │ │ weechat.look.bare_display_time_format string "%H:%M" │ │ │ weechat.look.buffer_auto_renumber boolean on │ │ │ weechat.look.buffer_notify_default enum all │ │ │ weechat.look.buffer_position enum end │ │ │ weechat.look.buffer_search_case_sensitive boolean off │ │ │ weechat.look.buffer_search_force_default boolean off │ │ │ weechat.look.buffer_search_history enum local │ │ │ weechat.look.buffer_search_regex boolean off │ │ │ weechat.look.buffer_search_where enum prefix_message │ │ │ weechat.look.buffer_time_format string "%H:%M:%S" │ │ │[12:55] [2] [fset] 2:fset │ │ │█ │ └──────────────────────────────────────────────────────────────────────────────────────┘
Commands
-
fset
: fast set WeeChat and plugins options
/fset -bar -refresh -up|-down [<number>] -left|-right [<percent>] -go <line>|end -toggle -add [<value>] -reset -unset -set -setnew -append -mark -format -export [-help|-nohelp] <filename> -import <filename> <filter> -bar: add the help bar -refresh: refresh list of options, then whole screen (command: /window refresh) -up: move the selected line up by "number" lines -down: move the selected line down by "number" lines -left: scroll the buffer by "percent" of width on the left -right: scroll the buffer by "percent" of width on the right -go: select a line by number, first line number is 0 ("end" to select the last line) -toggle: toggle the boolean value -add: add "value" (which can be a negative number) for integers, colors and enums, set/append to value for other types (set for a negative value, append for a positive value) -reset: reset the value of option -unset: unset the option -set: add the /set command in input to edit the value of option (move the cursor at the beginning of value) -setnew: add the /set command in input to edit a new value for the option -append: add the /set command to append something in the value of option (move the cursor at the end of value) -mark: toggle mark -format: switch to the next available format -export: export the options and values displayed to a file (each line has format: "/set name value" or "/unset name") -import: import the options from a file (all lines containing commands are executed) -help: force writing of help on options in exported file (see /help fset.look.export_help_default) -nohelp: do not write help on options in exported file (see /help fset.look.export_help_default) filter: set a new filter to see only matching options (this filter can be used as input in fset buffer as well); allowed formats are: `*`: show all options (no filter) `xxx`: show only options with "xxx" in name `f:xxx`: show only configuration file "xxx" `t:xxx`: show only type "xxx" (bool/int/str/col/enum or boolean/integer/string/color/enum) `d`: show only changed options `d:xxx`: show only changed options with "xxx" in name `d=xxx`: show only changed options with "xxx" in value `d==xxx`: show only changed options with exact value "xxx" `h=xxx`: show only options with "xxx" in description (translated) `he=xxx`: show only options with "xxx" in description (in English) `=xxx`: show only options with "xxx" in value `==xxx`: show only options with exact value "xxx" `c:xxx`: show only options matching the evaluated condition "xxx", using following variables: file, section, option, name, parent_name, type, type_en, type_short (bool/int/str/col/enum), type_tiny (b/i/s/c/e), default_value, default_value_undef, value, quoted_value, value_undef, value_changed, parent_value, min, max, description, description2, description_en, description_en2, string_values, allowed_values The lines with options are displayed using string evaluation (see /help eval for the format), with these options: - fset.format.option1: first format for an option - fset.format.option2: second format for an option The following variables can be used in these options: - option data, with color and padded by spaces on the right: - ${file}: configuration file (for example "weechat" or "irc") - ${section}: section - ${option}: option name - ${name}: full option name (file.section.option) - ${parent_name}: parent option name - ${type}: option type (translated) - ${type_en}: option type (in English) - ${type_short}: short option type (bool/int/str/col/enum) - ${type_tiny}: tiny option type (b/i/s/c/e) - ${default_value}: option default value - ${default_value_undef}: "1" if default value is null, otherwise "0" - ${value}: option value - ${value_undef}: "1" if value is null, otherwise "0" - ${value_changed}: "1" if value is different from default value, otherwise "0" - ${value2}: option value, with inherited value if null - ${parent_value}: parent option value - ${min}: min value - ${max}: max value - ${description}: option description (translated) - ${description2}: option description (translated), "(no description)" (translated) if there's no description - ${description_en}: option description (in English) - ${description_en2}: option description (in English), "(no description)" if there's no description - ${string_values}: string values allowed for set of an enum option - ${allowed_values}: allowed values - ${marked}: "1" if option is marked, otherwise "0" - ${index}: index of option in list - option data, with color but no spaces: - same names prefixed by underscore, for example: ${_name}, ${_type}, ... - option data, raw format (no colors/spaces): - same names prefixed by two underscores, for example: ${__name}, ${__type}, ... - option data, only spaces: - same names prefixed with "empty_", for example: ${empty_name}, ${empty_type} - other data: - ${selected_line}: "1" if the line is selected, otherwise "0" - ${newline}: insert a new line at point, so the option is displayed on multiple lines For keys, input and mouse actions on the buffer, see key bindings in User's guide. Note: if input has one or more leading spaces, the following text is interpreted as a filter, without the spaces. For example " q" searches all options with "q" inside name while "q" closes the fset buffer. Examples: /fset d:irc.* /fset nicklist /fset =red /fset ==red /fset c:${file} == irc && ${type_en} == integer
Options
Sections in file fset.conf:
Section | Control command | Description |
---|---|---|
|
|
Colors. |
|
|
Formats used to display list of options. |
|
|
Look and feel. |
Options:
-
-
description: color for allowed 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
fset.color.allowed_values_selected
-
description: color for allowed values on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for color name when option fset.look.use_color_value is enabled
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
246
-
-
fset.color.color_name_selected
-
description: color for color name on the selected line when option fset.look.use_color_value is enabled
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for default value
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
fset.color.default_value_selected
-
description: color for default value on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for description
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
242
-
-
fset.color.description_selected
-
description: color for description on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for file
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for file if value 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
fset.color.file_changed_selected
-
description: color for file if value is changed on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for file on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for default value in help 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for description in help 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for name in help 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for quotes around string 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
darkgray
-
-
-
description: color for allowed 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for index of option
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
-
description: color for index of option on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightcyan
-
-
-
description: background color for a marked line (used with the first format, see option fset.format.option1)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
17
-
-
-
description: background color for a marked line (used with the second format, see option fset.format.option2)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
17
-
-
-
description: background color for the selected line (used with the first format, see option fset.format.option1)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
24
-
-
-
description: background color for the selected line (used with the second format, see option fset.format.option2)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
24
-
-
-
description: color for mark indicator
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
-
description: color for mark indicator on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for max value
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for max value on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for min value
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for min value on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for name if value 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
185
-
-
fset.color.name_changed_selected
-
description: color for name if value is changed on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for name on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for option
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for option if value 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
fset.color.option_changed_selected
-
description: color for option if value is changed on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for option on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for name of parent option
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
fset.color.parent_name_selected
-
description: color for name of parent option on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for value of parent option
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
fset.color.parent_value_selected
-
description: color for value of parent option on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightcyan
-
-
-
description: color for quotes around string 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
darkgray
-
-
-
description: color for quotes around string values which are 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
fset.color.quotes_changed_selected
-
description: color for quotes around string values which are changed on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for quotes around string values on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for section
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for section if value 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
fset.color.section_changed_selected
-
description: color for section if value is changed on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for section on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for string 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
fset.color.string_values_selected
-
description: color for string values on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
fset.color.title_count_options
-
description: color for the count of options found with the current filter in title of 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
fset.color.title_current_option
-
description: color for current option number in title of 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightcyan
-
-
-
description: color for filter in title of 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
fset.color.title_marked_options
-
description: color for number of marked options in title of 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightgreen
-
-
-
description: color for sort in title of 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for type
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
138
-
-
-
description: color for type on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
216
-
-
-
description: color for mark indicator when the option is not marked
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: color for mark indicator when the option is not marked on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: color for value
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
38
-
-
-
description: color for value changed (different from default)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
185
-
-
fset.color.value_changed_selected
-
description: color for value changed (different from default) on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for value on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
159
-
-
-
description: color for undefined value
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
magenta
-
-
fset.color.value_undef_selected
-
description: color for undefined value on the selected 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightmagenta
-
-
-
description: format of help line written before each option exported in a file (note: content is evaluated, see /help fset)
-
type: string
-
values: any string
-
default value:
"# ${description2}"
-
-
-
description: format of each option exported in a file (note: content is evaluated, see /help fset)
-
type: string
-
values: any string
-
default value:
"/set ${name} ${quoted_value}"
-
-
fset.format.export_option_null
-
description: format of each option with "null" value exported in a file (note: content is evaluated, see /help fset)
-
type: string
-
values: any string
-
default value:
"/unset ${name}"
-
-
-
description: first format of each line, used when option fset.look.format_number is set to 1 (note: content is evaluated, see /help fset); an empty string uses the default format ("${marked} ${name} ${type} ${value2}"), which is without evaluation of string and then much faster; formats can be switched with key ctrl-x
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: second format of each line, used when option fset.look.format_number is set to 2 (note: content is evaluated, see /help fset); an empty string uses the default format ("${marked} ${name} ${type} ${value2}"), which is without evaluation of string and then much faster; formats can be switched with key ctrl-x
-
type: string
-
values: any string
-
default value:
"${marked} ${name} ${type} ${value2}${newline} ${empty_name} ${_default_value}${color:244} -- ${_allowed_values}${newline} ${empty_name} ${_description}"
-
-
-
description: comma separated list of options to automatically refresh on the fset buffer (if opened); "*" means all options (recommended), a name beginning with "!" is a negative value to prevent an option to be refreshed, wildcard "*" is allowed in names (example: "*,!plugin.section.*")
-
type: string
-
values: any string
-
default value:
"*"
-
-
-
description: automatically unmark all options after an action on marked options or after a refresh
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: condition to catch /set command and display results in the fset buffer; following variables can be used: ${name} (name of option given for the /set command), ${count} (number of options found with the /set argument); an empty string disables the catch of /set command; with value "1", the fset buffer is always used with /set command
-
type: string
-
values: any string
-
default value:
"${count} >= 1"
-
-
-
description: write help for each option exported by default (this can be overridden with arguments "-help" and "-nohelp" for command /fset -export)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: number of format used to display options; this is dynamically changed by the key ctrl-x on the fset buffer
-
type: integer
-
values: 1 .. 2
-
default value:
1
-
-
-
description: string displayed when an option is marked (to do an action on multiple options)
-
type: string
-
values: any string
-
default value:
"*"
-
-
-
description: left/right scroll in fset buffer (percent of width)
-
type: integer
-
values: 1 .. 100
-
default value:
10
-
-
-
description: show the plugin description options (plugins.desc.*)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: comma-separated list of fields to sort options (see /help fset for a list of fields); char "-" can be used before field to reverse order, char "~" can be used to do a case-insensitive comparison; example: "-~name" for case-insensitive and reverse sort on option name
-
type: string
-
values: any string
-
default value:
"~name"
-
-
-
description: string displayed when an option is not marked
-
type: string
-
values: any string
-
default value:
" "
-
-
-
description: use the color to display value of color options
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: use keys alt+X in fset buffer to do actions on options; if disabled, only the input is allowed
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: use /mute command to set options
-
type: boolean
-
values: on, off
-
default value:
off
-
7.2. Colors
Basic colors
Basic colors in WeeChat are:
Name | Color |
---|---|
|
Default terminal color (transparent for background) |
|
Black |
|
Dark gray |
|
Dark red |
|
Light red |
|
Dark green |
|
Light green |
|
Brown |
|
Yellow |
|
Dark blue |
|
Light blue |
|
Dark magenta |
|
Light magenta |
|
Dark cyan |
|
Light cyan |
|
Gray |
|
White |
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
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
Attributes
It is possible to use some attributes for colors. One or more attributes can be added before color name or number:
-
%
: blink -
.
: "dim" (half bright) -
*
: bold text -
!
: reverse video -
/
: italic -
_
: underlined text -
|
: keep attributes: do not reset blink/dim/bold/reverse/italic/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
7.3. Charset
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
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 set charset for all channels/privates of an IRC server:
/set charset.encode.irc.libera ISO-8859-15
To see all charsets used, use following command:
/set charset.*
Troubleshooting
For any problem with charsets, please look at WeeChat FAQ / Charset ↗.
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
Options
Sections in file charset.conf:
Section | Control command | Description |
---|---|---|
|
|
Default decoding/encoding charset. |
|
|
Decoding charset by buffer (options can be added/removed in section). |
|
|
Encoding charset by buffer (options can be added/removed in section). |
Options:
-
-
description: global decoding charset: charset used to decode incoming messages when they are not UTF-8 valid
-
type: string
-
values: any string
-
default value:
"iso-8859-1"
-
-
-
description: global encoding charset: charset used to encode outgoing messages (if empty, default is UTF-8 because it is the WeeChat internal charset)
-
type: string
-
values: any string
-
default value:
""
-
7.4. Notify levels
Setup notify levels
Four levels are possible in messages displayed in buffers, from lower to higher:
-
low: message with low importance (for example irc join/part/quit)
-
message: message from a user
-
private: message in a private buffer
-
highlight: message with highlight
Each buffer has a notify level, which is used to decide what messages will add buffer in hotlist.
The default notify level can be set using option weechat.look.buffer_notify_default, default is all.
Notify level | Level of messages added to hotlist |
---|---|
|
(none) |
|
highlight + private |
|
highlight + private + message |
|
highlight + private + message + low |
Notify level can be defined for a set of buffers, for example all buffers of irc server "libera":
/set weechat.notify.irc.libera message
Set notify level highlight on channel "#weechat" only:
/set weechat.notify.irc.libera.#weechat highlight
The notify level for a buffer can be set with command /buffer
:
/buffer notify highlight
Max hotlist level for nicks
It is possible to set max hotlist level for some nicks, per buffer, or per group of buffers (like IRC servers).
The buffer property "hotlist_max_level_nicks" can be set with a list of nicks and for each nick the max hotlist level to trigger, possible levels are:
-
-1: no hotlist changes for nick
-
0: low priority (like join/part messages)
-
1: message
-
2: private message
-
3: highlight (in fact useless, since it’s already the default max for all messages)
For example to disable highlights from "joe" and "mike" on current buffer:
/buffer setauto hotlist_max_level_nicks_add joe:2,mike:2
7.5. Highlights
Disable highlights
You can disable highlights with option
weechat.look.highlight_disable_regex
(regular expression).
When a highlight is disabled with this option, the other highlight options are
ignored.
For example to disable any highlight on messages with a word beginning with "flash" between chevrons:
/set weechat.look.highlight_disable_regex "<flash.*>"
This can also be set with the buffer property "highlight_disable_regex".
Same example, specific to the current buffer:
/buffer setauto highlight_disable_regex <flash.*>
Add words to highlight
By default, WeeChat highlights messages from other users containing your nick, therefore the highlight depends on the buffer (the nick can be different from one buffer to another).
You can add other words to highlight with the option weechat.look.highlight, for example to highlight your nick and "word1", "word2" and all words beginning with "test":
/set weechat.look.highlight "word1,word2,test*"
If you need a more specific rule for the word, you can use regular expressions with the option weechat.look.highlight_regex, for example to highlight words "flashcode", "flashcöde" and "flashy":
/set weechat.look.highlight_regex "flashc[oö]de|flashy"
The delimiters around words to highlight can be customized with the option weechat.look.word_chars_highlight.
Add tags to highlight
Lines displayed can contain "tags", which give some info about the origin of
message or the message itself.
You can display tags with the command /debug tags
(same command to hide them).
You can add specific tags to highlight with the option
weechat.look.highlight_tags.
Tags are separated by commas, and multiple tags can be separated by +
to do
a logical "and" between them.
For example to highlight all messages from nick "FlashCode" and all notices from nicks beginning with "toto":
/set weechat.look.highlight_tags "nick_flashcode,irc_notice+nick_toto*"
7.6. Buffer logging
The Logger plugin lets you save content of buffers to files, with options about what and how it is saved.
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.libera.#weechat 3
-
Set level 3 for libera server buffer:
/set logger.level.irc.server.libera 3
-
Set level 3 for all channels on server libera:
/set logger.level.irc.libera 3
-
Set level 2 for all IRC buffers:
/set logger.level.irc 2
Filenames masks
It is possible to define a filename mask for each buffer, and use local buffer variables to build filename. To see available local variables for current buffer:
/buffer listvar
Masks will be matched on options in descending order of specificity on
logger.mask.$plugin.*
, with logger.file.mask
as fallback option.
For example, on buffer "irc.libera.#weechat", WeeChat will search a mask with option name, in this order:
logger.mask.irc.libera.#weechat logger.mask.irc.libera logger.mask.irc logger.file.mask
That means you can have masks specific for some IRC servers ("logger.mask.irc.libera") 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:
~/.local/share/weechat └── logs ├── 2010 │ ├── 11 │ │ ├── irc.server.libera.weechatlog │ │ └── irc.libera.#weechat.weechatlog │ └── 12 │ ├── irc.server.libera.weechatlog │ └── irc.libera.#weechat.weechatlog ├── 2011 │ ├── 01 │ │ ├── irc.server.libera.weechatlog │ │ └── irc.libera.#weechat.weechatlog │ ├── 02 ...
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:
~/.local/share/weechat └── logs └── irc ├── libera │ ├── libera.weechatlog │ ├── #weechat.weechatlog │ └── #mychan.weechatlog ├── oftc │ ├── oftc.weechatlog │ ├── #channel1.weechatlog │ └── #channel2.weechatlog ...
Rotation and compression
It is possible to define a max size for log files, and when it is reached, there is automatic rotation of log file.
The rotated log files can be compressed with gzip or zstd ↗.
Note
|
As the compression of a file can take some time, it is performed in background. |
Example with a max size of 2GB and compression with gzip, using good compression level (slower than default one):
/set logger.file.rotation_compression_type gzip /set logger.file.rotation_compression_level 80 /set logger.file.rotation_size_max "2g"
If you want to use a decimal number, you can use the unit below and multiply by 1000, for example to set max size to 2.5GB:
/set logger.file.rotation_size_max "2500m"
With these settings, you’ll end with files like these ones (in this example there is rotation only for the log of #weechat channel):
~/.local/share/weechat └── logs ├── core.weechat.weechatlog ├── irc.server.libera.weechatlog ├── irc.libera.#weechat.weechatlog ├── irc.libera.#weechat.weechatlog.1.gz ├── irc.libera.#weechat.weechatlog.2.gz └── irc.libera.#weechat.weechatlog.3.gz
Commands
-
logger
: logger plugin configuration
/logger list set <level> flush 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) flush: write all log files now 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 (channel and private), notice (server and channel) 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"
Options
Sections in file logger.conf:
Section | Control command | Description |
---|---|---|
|
|
Look and feel. |
|
|
Colors. |
|
|
Options for log files. |
|
|
Log level by buffer (options can be added/removed in section). |
|
|
Filename mask by buffer (options can be added/removed in section). |
Options:
-
-
description: color for line ending the backlog
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
246
-
-
-
description: color for backlog lines, used only if the option logger.file.color_lines is off
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
246
-
-
-
description: automatically save content of buffers to files (unless a buffer disables log); if disabled, logging is disabled on all buffers
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: use ANSI color codes in lines written in log files and display backlog lines with these colors
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
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
-
-
-
description: use fsync to synchronize the log file with the storage device after the flush (see man fsync); this is slower but should prevent any data loss in case of power failure during the save of log file
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: write information line in log file when log starts or ends for a buffer
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: conditions to save content of buffers to files (note: content is evaluated, see /help eval); empty value saves content on all buffers; for example to log only private buffers: "${type} == private"
-
type: string
-
values: any string
-
default value:
""
-
-
-
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 (you should use only variables that are defined on all buffers, so for example you should NOT use $server nor $channel); date specifiers are permitted (see man strftime)
-
type: string
-
values: any string
-
default value:
"$plugin.$name.weechatlog"
-
-
-
description: use only lower case for log filenames
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: text to write before nick in prefix of message, example: "<"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: text to write after nick in prefix of message, example: ">"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: path for WeeChat log files; date specifiers are permitted (see man strftime) (path is evaluated, see function string_eval_path_home in plugin API reference)
-
type: string
-
values: any string
-
default value:
"${weechat_data_dir}/logs"
-
-
-
description: replacement char for special chars in filename built with mask (like directory delimiter)
-
type: string
-
values: any string
-
default value:
"_"
-
-
logger.file.rotation_compression_level
-
description: compression level for rotated log files (with extension ".1", ".2", etc.), if option logger.file.rotation_compression_type is enabled: 1 = low compression / fast ... 100 = best compression / slow; the value is a percentage converted to 1-9 for gzip and 1-19 for zstd; the default value is recommended, it offers a good compromise between compression and speed
-
type: integer
-
values: 1 .. 100
-
default value:
20
-
-
logger.file.rotation_compression_type
-
description: compression type for rotated log files; if set to "none", rotated log files are not compressed; WARNING: if rotation was enabled with another type of compression (or no compression), you must first unload the logger plugin, compress files with the new type (or decompress files), then change the option in logger.conf, then load the logger plugin
-
type: enum
-
values: none, gzip, zstd
-
default value:
none
-
-
-
description: when this size is reached, a rotation of log files is performed: the existing rotated log files are renamed (.1 becomes .2, .2 becomes .3, etc.) and the current file is renamed with extension .1; an integer number with a suffix is allowed: b = bytes (default if no unit given), k = kilobytes, m = megabytes, g = gigabytes, t = terabytes; example: "2g" causes a rotation if the file size is > 2,000,000,000 bytes; if set to "0", no rotation is performed (unlimited log size); WARNING: before changing this option, you should first set the compression type via option logger.file.rotation_compression_type
-
type: string
-
values: any string
-
default value:
"0"
-
-
-
description: timestamp used in log files (see man strftime for date/time specifiers, extra specifiers are supported, see function util_strftimeval in Plugin API reference)
-
type: string
-
values: any string
-
default value:
"%Y-%m-%d %H:%M:%S"
-
-
-
description: maximum number of lines to display from log file when creating new buffer (0 = no backlog)
-
type: integer
-
values: 0 .. 2147483647
-
default value:
20
-
-
logger.look.backlog_conditions
-
description: conditions to display the backlog (note: content is evaluated, see /help eval); empty value displays the backlog on all buffers; for example to display backlog on private buffers only: "${type} == private"
-
type: string
-
values: any string
-
default value:
""
-
7.7. Mouse support
WeeChat supports mouse clicks and gestures. It is working with local terminal, and remotely via ssh connection with or without screen/tmux.
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+% to disable mouse for 10 seconds:
/key bind meta-% /mouse toggle 10
Important
|
When mouse is enabled in WeeChat, all mouse events are caught by WeeChat, so
actions such as copy/paste or clicks on URLs are not sent to the terminal. Using Shift key causes the events to be sent directly to the 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 / Mouse ↗. |
Bind mouse events to commands
Many default mouse events are already defined by WeeChat (see mouse actions).
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 (by order in the event name):
Modifier | Description |
---|---|
|
Key Alt |
|
Key Ctrl |
|
Key Shift (1) |
Note
|
(1) The shift modifier can rarely be used in WeeChat because many terminals
use this modifier to catch directly mouse events.
|
Several modifiers can be combined, for example:
-
alt-ctrl
-
ctrl-shift
-
alt-ctrl-shift
List of buttons/wheel:
Button/wheel | Description |
---|---|
|
Click on left button |
|
Click on right button |
|
Click on middle button (often click on wheel) |
|
Click on extra buttons |
|
Wheel (up) |
|
Wheel (down) |
List of gestures (only for buttons, not wheel):
Gesture | Distance |
---|---|
|
3 … 19 |
|
≥ 20 |
|
3 … 19 |
|
≥ 20 |
|
3 … 39 |
|
≥ 40 |
|
3 … 39 |
|
≥ 40 |
List of incomplete events (only for buttons, useful for plugins/scripts):
Event | Description |
---|---|
|
Button was pressed but not released yet |
|
Mouse was moved with button pressed down |
Example of events:
-
button1
-
ctrl-button1
-
button1-gesture-right
-
button1-event-down
-
button1-event-drag
-
alt-button2-gesture-down-long
-
wheelup
-
alt-ctrl-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.
|
7.8. Spell checking
Spell plugin lets you check spelling in command line. It is possible to use many languages by buffer.
Spell checking is disabled by default and can be toggled with key Alt+s.
Dictionaries
Before using spell checking, dictionaries must be defined, either globally or specific to buffers.
Multiple dictionaries can be used at same time: WeeChat will check words in all dictionaries.
For example to use English and French:
/set spell.check.default_dict "en,fr"
It is possible to use a different dictionary on a specific buffer, for example on a German channel:
/spell setdict de
You can also specify a dictionary for a group of buffers, for example English for all channels on libera IRC server:
/set spell.dict.irc.libera en
For more information, see the command /spell.
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 spell.option.ignore-case "true"
Suggestions
Suggestions are displayed in a bar item called "spell_suggest". The number of suggestions is set in option spell.check.suggestions.
To enable suggestions you must set option spell.check.suggestions to an integer ≥ 0 and add the bar item "spell_suggest" to a bar, like status.
Example of suggestions with English dictionary (en
):
│[12:55] [6] [irc/libera] 3:#test(+n){4} [print,prone,prune] │ │[@Flashy] prinr █ │ └─────────────────────────────────────────────────────────────────────────────────┘
Example of suggestions with English and French dictionaries (en,fr
):
│[12:55] [6] [irc/libera] 3:#test(+n){4} [print,prone,prune/prime,primer,primé] │ │[@Flashy] prinr █ │ └─────────────────────────────────────────────────────────────────────────────────┘
Commands
-
spell
: spell plugin configuration
/spell enable|disable|toggle listdict setdict -|<dict>[,<dict>...] deldict addword [<dict>] <word> enable: enable spell checker disable: disable spell checker toggle: toggle spell checker listdict: show installed dictionaries setdict: set dictionary for current buffer (multiple dictionaries can be separated by a comma, the special value "-" disables spell checking on current buffer) deldict: delete dictionary used on current buffer addword: add a word in personal dictionary Input line beginning with a "/" is not checked, except for some commands (see /set spell.check.commands). To enable spell checker on all buffers, use option "default_dict", then enable spell checker, for example: /set spell.check.default_dict "en" /spell enable To display a list of suggestions in a bar, use item "spell_suggest". Default key to toggle spell checker is alt-s.
Options
Sections in file spell.conf:
Section | Control command | Description |
---|---|---|
|
|
Colors. |
|
|
Options to control spell checking. |
|
|
Dictionaries used by buffer (options can be added/removed in section). |
|
|
Look and feel. |
|
|
Speller options (options can be added/removed in section). |
Options:
-
-
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:
"away,command,cycle,kick,kickban,me,msg,notice,part,query,quit,topic"
-
-
-
description: default dictionary (or comma separated list of dictionaries) to use when buffer has no dictionary defined (leave blank to disable spell checker on buffers for which you didn't explicitly enabled it)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: check words during text search in buffer
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: enable spell checker for command line
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
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
-
-
-
description: number of suggestions to display in bar item "spell_suggest" for each dictionary set in buffer (-1 = disable suggestions, 0 = display all possible suggestions in all languages)
-
type: integer
-
values: -1 .. 2147483647
-
default value:
-1
-
-
-
description: minimum length for a word to be spell checked (use 0 to check all words)
-
type: integer
-
values: 0 .. 2147483647
-
default value:
2
-
-
-
description: text color for misspelled words (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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightred
-
-
-
description: text color for suggestion on a misspelled word in bar item "spell_suggest"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
spell.color.suggestion_delimiter_dict
-
description: text color for delimiters displayed between two dictionaries in bar item "spell_suggest"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
spell.color.suggestion_delimiter_word
-
description: text color for delimiters displayed between two words in bar item "spell_suggest"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
spell.look.suggestion_delimiter_dict
-
description: delimiter displayed between two dictionaries in bar item "spell_suggest"
-
type: string
-
values: any string
-
default value:
" / "
-
-
spell.look.suggestion_delimiter_word
-
description: delimiter displayed between two words in bar item "spell_suggest"
-
type: string
-
values: any string
-
default value:
","
-
7.9. Bars
A bar is an area beside the chat that can contain any type of text.
The bar options can be set with options weechat.bar.name.option
where name
is the name of the bar and option
the option for this bar.
List of bar options:
Option | Values | Description |
---|---|---|
|
|
A bar with type |
|
|
Position of the bar: above/below chat, on the left/right. |
|
integer ≥ 0 |
Priority for display of bar: this is used for ordering the bars on screen when
many bars have same type and position. |
|
integer ≥ 0 |
The size of the bar: number of columns for position left/right, number
of lines for position top/bottom. A size of |
|
integer ≥ 0 |
The maximum size for a bar, |
|
color |
The default background color for the bar. |
|
color |
The default text color for the bar. |
|
color |
The color for delimiters in bar. |
|
|
When option is |
|
|
When option is |
|
string |
A list of items (see items for more info). |
|
|
Type of filling for a bar which has position |
|
|
Type of filling for a bar which has position |
|
string |
The conditions to display the bar (see conditions for more info). |
Items
The option items is a string with a list of bar items, separated by a comma
(space between items on screen) or +
(glued items).
The list of bar items is displayed with command /bar listitems
.
Before or after item name, you can use chars (that are not alphanumeric, -
or _
). They will be displayed before/after item with the delimiters color
defined in bar (option color_delim).
Example of bar with items "[time],buffer_number+:+buffer_plugin+.+buffer_name,[buffer_last_number]":
┌───────────────────────────────────────────────────────────────────────────┐ │[12:55] 3:irc/libera.#weechat [9] │ └───────────────────────────────────────────────────────────────────────────┘
Spacer item
An item called spacer
can be used to align items (left, center, right).
When at least one spacer
item is used in a bar, the whole bar width is used:
the spacers auto expand with the same size (or almost).
When the bar is not large enough for all items, spacers are not displayed.
Note
|
The spacer bar item can be used only in bars with position top or bottom ,
filling horizontal and size 1 .
|
Example of bar with items "[time],spacer,buffer_number+:+buffer_plugin+.+buffer_name,spacer,[buffer_last_number]":
┌───────────────────────────────────────────────────────────────────────────┐ │[12:55] 3:irc/libera.#weechat [9]│ └───────────────────────────────────────────────────────────────────────────┘
Force buffer
A special syntax can be used to force the buffer used when displaying the bar item: "@buffer:item" (where "buffer" is the full name of buffer and "item" is the name of a bar item).
This is useful in root bars, to display item for a specific buffer which is not displayed in the current window (or even not displayed at all).
Example: nicklist of bitlbee in a root bar (if the bar is called bitlist and if bitlbee server is called bitlbee):
/set weechat.bar.bitlist.items "@irc.bitlbee.&bitlbee:buffer_nicklist"
Custom bar items
Custom bar items can be added with the /item command, each new item having two properties defined via configuration options:
-
conditions
: evaluated conditions to display the bar item, for example to restrict the bar item to some specific buffers (if empty, the bar item is displayed everywhere) -
content
: evaluated content of bar item.
In both options, the following variables can be used:
-
window
: pointer to the window where the bar is displayed (NULL
for root bars) -
buffer
: pointer to buffer where the bar is displayed (current buffer for root bars).
Examples of conditions:
Condition | Description |
---|---|
|
Displayed in window bars only |
|
Displayed in all buffers with number = 1 |
|
Displayed in all IRC buffers |
|
Displayed in all buffers where local variable |
|
Displayed in all buffers where local variable |
Note
|
There’s no builtin way to refresh the custom bar items. You can use the Trigger plugin to force the refresh, for example via one or more signals received. |
For more information and examples, see the /item command.
Filling
There are four types of filling:
-
horizontal
: the items are displayed horizontally, from left to right. If there are new lines in items, a space is used to separate lines. -
vertical
: the items are displayed from top to bottom. If there are new lines in items, a new line is used to separate lines. -
columns_horizontal
: items are displayed using columns, where text is aligned on the left. The first item is on top left, the second is on same line, on the right. -
columns_vertical
: items are displayed using columns, where text is aligned on the left. The first item is on top left, the second is one line below.
Default bars title, status and input have horizontal filling, and default bar nicklist has vertical filling.
Some examples of filling for bar nicklist:
┌───────────────────────────────────────────────────────────────────────┐ │Welcome to #test, this is a test channel │ │12:54:15 peter | hey! │@carl │ │12:55:01 +Max | hello │@jessika│ │ │@maddy │ │ │%Diego │ │ │%Melody │ │ │+Max │ │ │ celia │ │ │ Eva │ │ │ freddy │ │ │ Harold^│ │ │ henry4 │ │ │ jimmy17│ │ │ jodie ▼│ │[12:55] [6] [irc/libera] 3:#test(+n){24} │ │[@carl] █ │ └───────────────────────────────────────────────────────────────────────┘ filling_left_right = vertical ▲ ┌───────────────────────────────────────────────────────────────────────┐ │Welcome to #test, this is a test channel │ │12:54:15 peter | hey! │@carl lee │ │12:55:01 +Max | hello │@jessika louise │ │ │@maddy mario │ │ │%Diego mark │ │ │%Melody peter │ │ │+Max Rachel │ │ │ celia richard│ │ │ Eva sheryl │ │ │ freddy Vince │ │ │ Harold^ warren │ │ │ henry4 zack │ │ │ jimmy17 │ │ │ jodie │ │[12:55] [6] [irc/libera] 3:#test(+n){24} │ │[@carl] █ │ └───────────────────────────────────────────────────────────────────────┘ filling_left_right = columns_vertical ▲ ┌───────────────────────────────────────────────────────────────────────┐ │@carl %Diego celia Harold^ jodie mario Rachel Vince │ │@jessika %Melody Eva henry4 lee mark richard warren │ │@maddy +Max freddy jimmy17 louise peter sheryl zack │ │───────────────────────────────────────────────────────────────────────│ │ │ filling_top_bottom = columns_vertical ▲ ┌───────────────────────────────────────────────────────────────────────┐ │@carl @jessika @maddy %Diego %Melody +Max celia Eva │ │ freddy Harold^ henry4 jimmy17 jodie lee louise mario │ │ mark peter Rachel richard sheryl Vince warren zack │ │───────────────────────────────────────────────────────────────────────│ │ │ filling_top_bottom = columns_horizontal ▲
Conditions
The option conditions is a string which is evaluated to know if the bar must be displayed or not.
The string can be:
-
active: the window must be active
-
inactive: the window must be inactive
-
nicklist: the buffer displayed in window must have a nicklist
-
an expression: it is evaluated as boolean (see command /eval)
For the expression, following variables are available:
-
${active}
: true if window is active -
${inactive}
: true if window is inactive -
${nicklist}
: true if buffer displayed in window has a nicklist
Following pointers are available:
-
${window}
: the window where condition is evaluated -
${buffer}
: the buffer of window where condition is evaluated
Example to display nicklist bar in all buffers with a nicklist, and only if width of terminal is > 100:
/set weechat.bar.nicklist.conditions "${nicklist} && ${info:term_width} > 100"
Same condition, but always display nicklist on buffer &bitlbee (even if terminal is small):
/set weechat.bar.nicklist.conditions "${nicklist} && (${info:term_width} > 100 || ${buffer.full_name} == irc.bitlbee.&bitlbee)"
7.10. Secured data
Storage
WeeChat can encrypt passwords or private data using secured data, stored in file sec.conf.
This configuration file is read before any other file, and the values stored inside can be used in various WeeChat or plugins/scripts options.
You can set a passphrase to encrypt data in sec.conf. This is not mandatory but highly recommended, otherwise data is stored as plain text in file.
/secure passphrase this is my passphrase
Passphrase on startup
When a passphrase is set, WeeChat will ask you to enter it on startup
(but not on /upgrade
).
If you are using a password manager, you can run an external program to read
the passphrase instead of having to type it manually on WeeChat startup.
For example with password-store (command pass
):
/set sec.crypt.passphrase_command "/usr/bin/pass show weechat/passphrase"
The program may ask you unlock your GPG key or enter another passphrase to
read the secret. WeeChat will wait for the end of the command to read the
passphrase on the standard output (it must be on the first line without any
extra character).
If the output contains no passphrase or if it is wrong, WeeChat will then ask
you to enter it.
Encryption
The encryption of data is made in 3 steps:
-
Derive a key from the passphrase (with optional salt).
-
Compute hash of data to encrypt.
-
Encrypt the hash + data (output is: salt + encrypted hash/data).
Note
|
The cipher block mode is CFB. |
The result is put as hexadecimal string in file sec.conf, for example:
[data] __passphrase__ = on libera = "53B1C86FCDA28FC122A95B0456ABD79B5AB74654F21C3D099A6CCA8173239EEA59533A1D83011251F96778AC3F5166A394"
Manage secured data
To add secured data, use /secure set
, for example a password for libera
IRC server:
/secure set libera mypassword
For comfort, secured data can be displayed in a dedicated buffer (Alt+v on buffer to see values), just do:
/secure
Secured data can be used in some options that can contain private data like
password, using this format: "${sec.data.xxx}" where "xxx" is the name of
secured data (used with /secure set xxx …
).
For a complete list of supported options, see the /secure command.
To use the libera password, for example with SASL authentication:
/set irc.server.libera.sasl_password "${sec.data.libera}"
7.11. Command aliases
Alias plugin lets you create alias for commands (from WeeChat or other plugins).
Some aliases are created by default, with name in upper case (to make them
different from standard commands); commands are not case-sensitive in WeeChat,
so for example /close
runs the alias /CLOSE
.
List of default aliases:
Alias | Command | Completion |
---|---|---|
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
%(buffers_plugins_names) |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
|
|
- |
Commands
-
alias
: list, add or remove command aliases
/alias list [<name>] add|addreplace <name> [<command>[;<command>...]] addcompletion|addreplacecompletion <completion> <name> [<command>[;<command>...]] del <name>|<mask>... rename <name> <new_name> missing list: list aliases (without argument, this list is displayed) add: add an alias addreplace: add or replace an existing alias addcompletion: add an alias with a custom completion addreplacecompletion: add or replace an existing alias with a custom completion name: name of alias completion: completion for alias: by default completion is done with target command (you can use "%%command" to use the completion of an existing command) command: command name with arguments (many commands can be separated by semicolons) del: delete aliases mask: name where wildcard "*" is allowed rename: rename an alias missing: add missing aliases (using default aliases) 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 $&: all arguments, with " replaced by \" $~: last argument $var: where "var" is a local variable of buffer (see /buffer listvar), examples: $nick, $channel, $server, $plugin, $name Examples: /alias add split /window splith /alias add hello /allchan -exclude=#weechat hello /alias rename hello Hello /alias addcompletion %%sajoin forcejoin /quote forcejoin
7.12. Commands and options
WeeChat commands
-
allbuf
: execute a command on all buffers
/allbuf <command> command: command to execute (or text to send to buffer if command does not start with "/") Example: set read marker on all buffers: /allbuf /buffer set unread
-
away
: set or remove away status
/away [-all] [<message>] -all: set or remove 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|addreplace <name> <type>[,<conditions>] <position> <size> <separator> <item1>[,<item2>...] default [input|title|status|nicklist] rename <name> <new_name> del <name>|<mask>... 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 addreplace: add or replace an existing bar name: name of bar (must be unique) type: type of bar: root: outside windows window: inside windows, with optional conditions (see below) conditions: the conditions to display the bar (without conditions, the bar is always displayed: active: on active window inactive: on inactive windows nicklist: on windows with nicklist other condition: see /help weechat.bar.xxx.conditions and /help eval 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) rename: rename a bar del: delete bars mask: name where wildcard "*" is allowed 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 ("*" 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 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 add [-free] [-switch] <name> clear [<id>|<number>|<name>|-merged|-all [<id>|<number>|<name>...]] move <number>|-|+ swap <id1>|<number1>|<name1> [<id2>|<number2>|<name2>] cycle <id>|<number>|<name>... merge <id>|<number>|<name> unmerge [<number>|-all] hide [<id>|<number>|<name>|-all [<id>|<number>|<name>...]] unhide [<id>|<number>|<name>|-all [<id>|<number>|<name>...]] switch [-previous] zoom renumber [<number1> [<number2> [<start>]]] close [<n1>[-<n2>]|<name>...] notify [<level>] listvar [<id>|<number>|<name>] setvar <name> [<value>] delvar <name> set <property> [<value>] setauto <property> [<value>] get <property> jump smart|last_displayed|prev_visited|next_visited <id>|<number>|-|+|<name> list: list buffers (without argument, this list is displayed) add: add a new buffer (it can be closed with "/buffer close" or input "q") 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); "-" = move to first buffer number, "+" = move to last buffer number + 1 swap: swap two buffers (swap with current buffer if only one number/name given) cycle: jump loop between a list of buffers 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 hide: hide the buffer unhide: unhide the buffer switch: switch to next merged buffer (or to previous buffer with "-previous") zoom: zoom on merged buffer renumber: renumber buffers (works only if option weechat.look.buffer_auto_renumber is off) close: close buffer (number/range or name is optional) notify: display or 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: for all messages reset: reset to default value (all) listvar: display local variables in a buffer setvar: set a local variable in the current buffer delvar: delete a local variable from the current buffer set: set a property in the current buffer setauto: like "set" and also define option "weechat.buffer.<name>.<property>" so that the property is saved in configuration and applied each time this buffer is opened get: display a property of current buffer jump: jump to another buffer: smart: next buffer with activity last_displayed: last buffer displayed (before last jump to a buffer) prev_visited: previously visited buffer next_visited: jump to next visited buffer id: jump to buffer by id 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" -: jump to first buffer number +: jump to last buffer number name: jump to buffer by (partial) name; if the name starts with "(?i)", the search is case-insensitive (for example "(?i)upper" will find buffer "irc.libera.#UPPERCASE") Examples: /buffer move 5 /buffer swap 1 3 /buffer swap #weechat /buffer cycle #chan1 #chan2 #chan3 /buffer merge 1 /buffer merge #weechat /buffer close 5-7 /buffer #weechat /buffer +1 /buffer +
-
color
: define color aliases and display palette of colors
/color alias <color> <name> unalias <color> reset term2rgb <color> rgb2term <rgb> [<limit>] -o 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") term2rgb: convert a terminal color (0-255) to RGB color rgb2term: convert a RGB color to terminal color (0-255) limit: number of colors to use in terminal table (starting from 0); default is 256 -o: send terminal/colors info to current buffer as input Without argument, this command displays colors in a new buffer. Examples: /color alias 214 orange /color unalias 214
-
command
: launch explicit WeeChat or plugin command
/command [-buffer <name>] <plugin> <command> -s <command>[;<command>...] -buffer: execute the command on this buffer plugin: execute the command from this plugin; "core" for a WeeChat command, "*" for automatic plugin (it depends on the buffer where the command is executed) command: command to execute (a "/" is automatically added if not found at beginning of command) -s: execute one or multiple commands separated by semicolons (the semicolon can be escaped with "\;")
-
cursor
: free movement of cursor on screen to execute actions on specific areas of screen
/cursor go chat|<bar> [top_left|top_right|bottom_left|bottom_right] go <x>,<y> move up|down|left|right|top_left|top_right|bottom_left|bottom_right|edge_top|edge_bottom|edge_left|edge_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. See chapter on key bindings in User's guide for a list of keys that can be used in cursor mode. Examples: /cursor go chat bottom_left /cursor go nicklist /cursor go 10,5
-
debug
: debug functions
/debug list set <plugin> <level> dump [<plugin>] hooks [<plugin_mask> [<hook_type>...]] buffer|certs|color|dirs|infolists|key|libs|memory|tags|term|url|windows callbacks <duration>[<unit>] mouse|cursor [verbose] hdata [free] time <command> unicode <string> 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) hooks: display infos about hooks (with a plugin: display detailed info about hooks created by the plugin) plugin_mask: plugin mask, "*" for all plugins hook_type: hook type buffer: dump buffer content with hexadecimal values in WeeChat log file callbacks: write hook and bar item callbacks that took more than "duration" in the WeeChat log file (0 = disable), where optional unit is one of: us: microseconds (default) ms: milliseconds s: seconds m: minutes h: hours certs: display number of loaded trusted certificate authorities color: display infos about current color pairs cursor: toggle debug for cursor mode dirs: display directories hdata: display infos about hdata (with free: remove all hdata in memory) infolists: display infos about infolists key: enable keyboard and mouse debug: display raw codes, expanded key name and associated command ("q" to quit this mode) libs: display infos about external libraries used memory: display infos about memory usage mouse: toggle debug for mouse tags: display tags for lines term: display infos about terminal url: toggle debug for calls to hook_url (display output hashtable) windows: display windows tree time: measure time to execute a command or to send text to the current buffer unicode: display information about string and unicode chars (evaluated, see /help eval) Examples: /debug set irc 1 /debug mouse verbose /debug time /filter toggle /debug hooks * process connect url /debug unicode ${chars:${\u26C0}-${\u26CF}}
-
eval
: evaluate expression
/eval [-n|-s] [-d] <expression> [-n] [-d [-d]] -c <expression1> <operator> <expression2> -n: display result without sending it to buffer (debug mode) -s: split expression before evaluating it (many commands can be separated by semicolons) -d: display debug output after evaluation (with two -d: more verbose debug) -c: evaluate as condition: use operators and parentheses, return a boolean value ("0" or "1") expression: expression to evaluate, variables with format ${variable} are replaced (see below) operator: a logical or comparison operator (see below) An expression is considered as "true" if it is not NULL, not empty, and different from "0". The comparison is made using floating point numbers if the two expressions are valid numbers, with one of the following formats: integer (examples: 5, -7), floating point number (examples: 5.2, -7.5, 2.83e-2), hexadecimal number (examples: 0xA3, -0xA3). To force a string comparison, you can add double quotes around each expression, for example: 50 > 100 == 0 and "50" > "100" == 1 Some variables are replaced in expression, using the format ${variable}, which can be, by order of priority: - ${raw_hl:string}: the string itself without evaluation but with syntax highlighting - ${raw:string}: the string itself without evaluation - ${hl:string}: the string with syntax highlighting - ${name}: the user-defined variable - ${weechat_config_dir}: WeeChat config directory - ${weechat_data_dir}: WeeChat data directory - ${weechat_state_dir}: WeeChat state directory - ${weechat_cache_dir}: WeeChat cache directory - ${weechat_runtime_dir}: WeeChat runtime directory - ${eval:string}: the evaluated string - ${eval_cond:string}: the evaluated condition - ${esc:string} or ${\string}: the string with escaped chars - ${chars:range}: the string with a range of chars, "range" is one of: "digit", "xdigit", "lower", "upper", "alpha", "alnum" or "c1-c2" ("c1" and "c2" are code points with c1 ≤ c2) - ${lower:string}: the string converted to lower case - ${upper:string}: the string converted to upper case - ${hide:char,string}: the string with hidden chars - ${cut:max,suffix,string}: the string with max chars (excluding the suffix) - ${cut:+max,suffix,string}: the string with max chars (including the suffix) - ${cutscr:max,suffix,string}: the string with max chars displayed on screen (excluding the suffix) - ${cutscr:+max,suffix,string}: the string with max chars displayed on screen (including the suffix) - ${rev:string}: the reversed string - ${revscr:string}: the reversed string for display (color codes are not reversed) - ${repeat:count,string}: the repeated string - ${length:string}: the length of the string (number of UTF-8 chars) - ${lengthscr:string}: the length of the string on screen (sum of the width of each UTF-8 char displayed on screen, colors codes are ignored) - ${split:N,separators,flags,string}: Nth item of the split string (N is an integer ≥ 1 or ≤ -1, if negative, counts from the last item) - ${split:random,separators,flags,string}: random item of the split string - ${split:count,separators,flags,string}: number of items of the split string - ${split_shell:N,string}: Nth item of the split shell arguments (N is an integer ≥ 1 or ≤ -1, if negative, counts from the last item) - ${split_shell:random,string}: random item of the split shell arguments - ${split_shell:count,string}: number of items of the split shell arguments - ${color:name}: the color (see "Plugin API reference", function "color") - ${modifier:name,data,string}: the modifier - ${info:name,arguments}: the info (arguments are optional) - ${base_encode:base,string}: the string encoded to base: 16, 32, 64 or 64url - ${base_decode:base,string}: the string decoded from base: 16, 32, 64 or 64url - ${date} or ${date:format}: current date/time - ${env:NAME}: the environment variable - ${if:condition?value_if_true:value_if_false}: the result of ternary operator - ${calc:expression}: the result of the expression with parentheses and operators (+, -, *, /, //, %, **) - ${random:min,max}: a random integer number between "min" and "max" (inclusive) - ${translate:string}: the translated string - ${define:name,value}: declaration of a user variable (return an empty string) - ${hdata_count:name[list]}: number of items in this hdata with list - ${hdata_count:name[ptr]}: number of items in this hdata with pointer - ${sec.data.xxx}: the value of the secured data "xxx" - ${file.section.option}: the value of the config option - ${name}: the local variable in buffer - the hdata name/variable (the value is automatically converted to string), by default "window" and "buffer" point to current window/buffer. Format for hdata can be one of following: - ${hdata.var1.var2...}: start with a hdata (pointer must be known), and ask variables one after one (other hdata can be followed) - ${hdata[list].var1.var2...}: start with a hdata using a list/pointer/pointer name, for example: - ${buffer[gui_buffers].full_name}: full name of first buffer in linked list of buffers - ${plugin[weechat_plugins].name}: name of first plugin in linked list of plugins - ${hdata[pointer].var1.var2...}: start with a hdata using a pointer, for example: - ${buffer[0x1234abcd].full_name}: full name of the buffer with this pointer (can be used in triggers) - ${buffer[my_pointer].full_name}: full name of the buffer with this pointer name (can be used in triggers) - ${hdata[pointer].var1.method()}: when var1 is a hashtable, methods can be called: "keys()", "values()", "keys_sorted()", "keys_values()" and "keys_values_sorted()" For name of hdata and variables, please look at "Plugin API reference", function "weechat_hdata_get". Logical operators (by order of priority): && boolean "and" || boolean "or" Comparison operators (by order of priority): =~ is matching POSIX extended regex !~ is NOT matching POSIX extended regex ==* is matching mask, case-sensitive (wildcard "*" is allowed) !!* is NOT matching mask, case-sensitive (wildcard "*" is allowed) =* is matching mask, case-insensitive (wildcard "*" is allowed) !* is NOT matching mask, case-insensitive (wildcard "*" is allowed) ==- is included, case-sensitive !!- is NOT included, case-sensitive =- is included, case-insensitive !- is NOT included, case-insensitive == equal != not equal <= less or equal < less >= greater or equal > greater Examples (simple strings): /eval -n ${raw:${info:version}} ==> ${info:version} /eval -n ${eval_cond:${window.win_width}>100} ==> 1 /eval -n ${info:version} ==> 4.5.0-dev /eval -n ${env:HOME} ==> /home/user /eval -n ${weechat.look.scroll_amount} ==> 3 /eval -n ${sec.data.password} ==> secret /eval -n ${window} ==> 0x2549aa0 /eval -n ${window.buffer} ==> 0x2549320 /eval -n ${window.buffer.full_name} ==> core.weechat /eval -n ${window.buffer.number} ==> 1 /eval -n ${buffer.local_variables.keys_values()} ==> plugin:core,name:weechat /eval -n ${buffer.local_variables.plugin} ==> core /eval -n ${hdata_count:buffer[gui_buffers]} ==> 15 /eval -n ${\t} ==> <tab> /eval -n ${chars:digit} ==> 0123456789 /eval -n ${chars:J-T} ==> JKLMNOPQRST /eval -n ${lower:TEST} ==> test /eval -n ${upper:test} ==> TEST /eval -n ${hide:-,${relay.network.password}} ==> -------- /eval -n ${cut:3,+,test} ==> tes+ /eval -n ${cut:+3,+,test} ==> te+ /eval -n ${date:%H:%M:%S} ==> 07:46:40 /eval -n ${if:${info:term_width}>80?big:small} ==> big /eval -n ${rev:Hello} ==> olleH /eval -n ${repeat:5,-} ==> ----- /eval -n ${length:test} ==> 4 /eval -n ${split:1,,,abc,def,ghi} ==> abc /eval -n ${split:-1,,,abc,def,ghi} ==> ghi /eval -n ${split:count,,,abc,def,ghi} ==> 3 /eval -n ${split:random,,,abc,def,ghi} ==> def /eval -n ${split_shell:1,"arg 1" arg2} ==> arg 1 /eval -n ${split_shell:-1,"arg 1" arg2} ==> arg2 /eval -n ${split_shell:count,"arg 1" arg2} ==> 2 /eval -n ${split_shell:random,"arg 1" arg2} ==> arg2 /eval -n ${calc:(5+2)*3} ==> 21 /eval -n ${random:0,10} ==> 3 /eval -n ${base_encode:64,test} ==> dGVzdA== /eval -n ${base_decode:64,dGVzdA==} ==> test /eval -n ${define:len,${calc:5+3}}${len}x${len} ==> 8x8 Examples (conditions): /eval -n -c ${window.buffer.number} > 2 ==> 0 /eval -n -c ${window.win_width} > 100 ==> 1 /eval -n -c (8 > 12) || (5 > 2) ==> 1 /eval -n -c (8 > 12) && (5 > 2) ==> 0 /eval -n -c abcd =~ ^ABC ==> 1 /eval -n -c abcd =~ (?-i)^ABC ==> 0 /eval -n -c abcd =~ (?-i)^abc ==> 1 /eval -n -c abcd !~ abc ==> 0 /eval -n -c abcd =* a*d ==> 1 /eval -n -c abcd =- bc ==> 1
-
filter
: filter messages in buffers, to hide/show them according to tags or regex
/filter list enable|disable|toggle [<name>|<mask>|@...] add|addreplace <name> <buffer>[,<buffer>...] <tags> <regex> rename <name> <new_name> recreate <name> del <name>|<mask>... list: list all filters enable: enable filters (filters are enabled by default) disable: disable filters toggle: toggle filters mask: name where wildcard "*" is allowed ("@" = enable/disable all filters in current buffer) add: add a filter addreplace: add or replace an existing filter name: filter name rename: rename a filter recreate: set input with the command used to edit the filter del: delete filters buffer: comma separated list of buffers where filter is active: - this is full name including plugin (example: "irc.libera.#weechat" or "irc.server.libera") - "*" means all buffers - a name starting with "!" is excluded - wildcard "*" is allowed tags: comma separated list of tags (for example "irc_join,irc_part,irc_quit"): - logical "and": "+" between tags (for example: "nick_toto+irc_action") - wildcard "*" is allowed - if tag starts with "!", then it is excluded and must NOT be in message regex: POSIX extended 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 globally and alt+"-" toggles filtering on/off in the current buffer. Tags most commonly used: no_filter, no_highlight, no_log, log0..log9 (log level), notify_none, notify_message, notify_private, notify_highlight, self_msg, nick_xxx (xxx is nick in message), prefix_nick_ccc (ccc is color of nick), host_xxx (xxx is username + host in message), irc_xxx (xxx is command name or number, see /server raw or /debug tags), 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.libera.#weechat nick_toto * filter IRC join/action messages from nick "toto": /filter add toto * nick_toto+irc_join,nick_toto+irc_action * filter lines containing "weechat sucks" on IRC channel #weechat: /filter add sucks irc.libera.#weechat * weechat sucks filter lines that are strictly equal to "WeeChat sucks" on all buffers: /filter add sucks2 * * (?-i)^WeeChat sucks$
-
help
: display help about commands and options
/help -list|-listfull [<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
-
hotlist
: manage hotlist
/hotlist add [low|message|private|highlight] clear [<level>] remove restore [-all] add: add current buffer in hotlist (default level: "low", conditions defined in option weechat.look.hotlist_add_conditions are NOT checked) clear: clear hotlist level: "lowest" to clear only lowest level in hotlist, highest" to clear only highest level in hotlist, or level mask: integer which is a combination of 1=join/part, 2=message, 4=private, 8=highlight remove: remove current buffer from hotlist restore: restore latest hotlist removed in the current buffer (or all buffers with "-all")
-
input
: functions for command line
/input <action> [<arguments>] action: the action, one of: return: simulate key "enter" split_return: split input on newlines then simulate key "enter" for each line complete_next: complete word with next completion complete_previous: complete word with previous completion search_text_here: search text in buffer at current position search_text: search text in buffer search_history: search text in command line history search_switch_case: switch exact case for search search_switch_regex: switch search type: string/regular expression search_switch_where: switch search in messages/prefixes search_previous: search previous line search_next: search next line search_stop_here: stop search at current position search_stop: stop search delete_previous_char: delete previous char delete_next_char: delete next char delete_previous_word: delete previous word delete_previous_word_whitespace: delete previous word (until whitespace) delete_next_word: delete next word delete_beginning_of_line: delete from beginning of line until cursor delete_beginning_of_input: delete from beginning of input until cursor delete_end_of_line: delete from cursor until end of line delete_end_of_input: delete from cursor until end of input delete_line: delete current line delete_input: delete entire input clipboard_paste: paste from the internal 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_beginning_of_input: move cursor to beginning of input move_end_of_line: move cursor to end of line move_end_of_input: move cursor to end of input 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 move_previous_line: move cursor to previous line move_next_line: move cursor to next line 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 history_use_get_next: send the current history entry (found with search or recalled with "up"key) and insert the next history entry in the command line without sending it 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 insert: insert text in command line (escaped chars are allowed, see /help print) send: send text to the buffer arguments: optional arguments for the action This command is used by key bindings or plugins.
-
item
: manage custom bar items
/item list add|addreplace <name> "<conditions>" "<content>" rename <name> <new_name> refresh <name>|<mask>... recreate <name> del <name>|<mask>... list: list all custom bar items add: add a custom bar item addreplace: add or replace an existing custom bar item name: custom bar item name mask: name where wildcard "*" is allowed conditions: evaluated conditions to display the bar item (for example to display the bar item only in specific buffers) content: content (evaluated, see /help eval) rename: rename a custom bar item refresh: update content of item in all bars where the item is displayed; any item can be refreshed: default/plugin/custom bar items recreate: set input with the command used to edit the custom bar item del: delete custom bar items Examples: add item with terminal size, displayed only in buffers with number = 1: /item add terminfo "${buffer.number} == 1" "term:${info:term_width}x${info:term_height}" add item with buffer info: /item add bufinfo "" "${buffer.number}:${buffer.name}${if:${buffer.zoomed}?(Z)}" add item with date/time using format "Dec 25, 12:34 +0100", refreshed every minute: /item add datetime "" "${date:%b %d, %H:%M %z}" /trigger add datetime_refresh timer "60000;60" "" "" "/item refresh datetime" add item with number of lines in buffer (displayed/total), refreshed each time a new line is displayed or if filtered lines have changed: /item add lines_count "" "${calc:${buffer.lines.lines_count}-${buffer.lines.lines_hidden}}/${buffer.lines.lines_count} lines" /trigger add lines_count_refresh_print print "" "" "" "/item refresh lines_count" /trigger add lines_count_refresh_signal signal "window_switch;buffer_switch;buffer_lines_hidden;filters_*" "" "" "/item refresh lines_count" force refresh of item "lines_count": /item refresh lines_count recreate item "lines_count" with different conditions or content: /item recreate lines_count delete item "lines_count": /item del lines_count
-
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>] legacy <key>... list: list all current keys 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 command: command (many commands can be separated by semicolons); quotes can be used to preserve spaces at the beginning/end of command 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 legacy: display new name for legacy keys 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 name in command line. For some keys you might need to use /debug key, this displays the raw key code that can be used (for example the key ctrl+backspace could be "ctrl-h" or "ctrl-?", depending on your terminal and other settings). Modifiers allowed (in this order when multiple are used): "meta-": alt key "ctrl-": control key "shift-": shift key, can only be used with key names below Key names allowed: f0 to f20, home, insert, delete, end, backspace, pgup, pgdn, up, down, right, left, tab, return, comma, space. Combo of keys must be separated by a comma. 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): chat 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" Wildcard "*" is allowed in key 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 bind meta-r /buffer #weechat /key reset meta-r /key bind meta-v,f1 /help /key bindctxt search f12 /input search_stop /key bindctxt mouse @item(buffer_nicklist):button3 /msg nickserv info ${nick}
-
layout
: manage buffers/windows layouts
/layout store [<name>] [buffers|windows] apply [<name>] [buffers|windows] leave del [<name>] [buffers|windows] rename <name> <new_name> store: store current buffers/windows in a layout apply: apply stored layout leave: leave current layout (does not update any layout) del: delete buffers and/or windows in a stored layout (if neither "buffers" nor "windows" is given after the name, the layout is deleted) rename: rename a layout name: name for stored layout (default is "default") buffers: store/apply only buffers (order of buffers) windows: store/apply only windows (buffer displayed by each window) Without argument, this command displays stored layouts. The current layout can be saved on /quit command with the option "weechat.look.save_layout_on_exit". Note: the layout only remembers windows split and buffers numbers. It does not open buffers. That means for example you must still auto-join IRC channels to open the buffers, the saved layout only applies once the buffers are opened.
-
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: /mouse enable /mouse toggle 5
-
mute
: execute a command silently
/mute [-core | -current | -buffer <name>] <command> -core: no output on WeeChat core buffer -current: no output on current buffer -buffer: no output on specified buffer name: full buffer name (examples: "irc.server.libera", "irc.libera.#weechat") command: command to execute silently (a "/" is automatically added if not found at beginning of command) If no target is specified ("-core", "-current" or "-buffer"), then default is to mute all buffers. Examples: /mute save /mute -current msg * hi! /mute -buffer irc.libera.#weechat msg #weechat hi!
-
plugin
: list/load/unload plugins
/plugin list [-o|-ol|-i|-il|<name>] listfull [<name>] load <filename> [<arguments>] autoload [<arguments>] reload [<name>|* [<arguments>]] unload [<name>] list: list loaded plugins -o: send list of loaded plugins to buffer (string in English) -ol: send list of loaded plugins to buffer (translated string) -i: copy list of loaded plugins in command line (for sending to buffer) (string in English) -il: copy list of loaded plugins in command line (for sending to buffer) (translated string) name: a plugin name listfull: list loaded plugins (verbose) load: load a plugin filename: plugin (file) to load arguments: arguments given to plugin on load 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) Without argument, this command lists loaded plugins.
-
print
: display text on a buffer
/print [-buffer <id>|<number>|<name>] [-newbuffer <name>] [-free] [-switch] [-core|-current] [-y <line>] [-escape] [-date <date>] [-tags <tags>] [-action|-error|-join|-network|-quit] [<text>] -stdout|-stderr [<text>] -beep -buffer: display text in this buffer (default: buffer where command is executed) -newbuffer: create a new buffer and display text in this buffer -free: create a buffer with free content (with -newbuffer only) -switch: switch to the buffer -core: alias of "-buffer core.weechat" -current: display text on current buffer -y: display on a custom line (for buffer with free content only) line: line number for buffer with free content (first line is 0, a negative number displays after last line: -1 = after last line, -2 = two lines after last line, etc.) -escape: interpret escaped chars (for example \a, \07, \x07) -date: message date, format can be: -n: "n" seconds before now +n: "n" seconds in the future n: "n" seconds since the Epoch (see man time) date and/or time (ISO 8601): see function "util_parse_time" in Plugin API reference (examples: "11:29:09", "2023-12-25T10:29:09.456789Z") -tags: comma-separated list of tags (see /help filter for a list of tags most commonly used) text: text to display (prefix and message must be separated by "\t", if text starts with "-", then add a "\" before) -stdout: display text on stdout (escaped chars are interpreted) -stderr: display text on stderr (escaped chars are interpreted) -beep: alias of "-stderr \a" The options -action ... -quit use the prefix defined in options "weechat.look.prefix_*". Following escaped chars are supported: \" \\ \a \b \e \f \n \r \t \v \0ooo \xhh \uhhhh \Uhhhhhhhh Examples: display a reminder on core buffer with a highlight: /print -core -tags notify_highlight Reminder: buy milk display an error on core buffer: /print -core -error Some error here display message on core buffer with prefix "abc": /print -core abc\tThe message display a message on channel #weechat: /print -buffer irc.libera.#weechat Message on #weechat display a snowman (U+2603): /print -escape \u2603 send alert (BEL): /print -beep
-
proxy
: manage proxies
/proxy list add|addreplace <name> <type> <address> <port> [<username> [<password>]] del <name>|<mask>... set <name> <option> <value> list: list all proxies add: add a new proxy addreplace: add or replace an existing proxy name: name of proxy (must be unique) type: http, socks4 or socks5 address: IP or hostname port: port number username: username (optional) password: password (optional) del: delete proxies mask: name where wildcard "*" is allowed 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: add a http proxy, running on local host, port 8888: /proxy add local http 127.0.0.1 8888 add a http proxy using IPv6 protocol only: /proxy add local http ::1 8888 /proxy set local ipv6 force add 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) By default when quitting the configuration files are saved (see option "weechat.look.save_config_on_exit") and the current layout can be saved (see option "weechat.look.save_layout_on_exit").
-
reload
: reload configuration files from disk
/reload [<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>[<unit>]] <count> <command> delay: delay between execution of commands (minimum: 1 millisecond) unit: optional, values are: us: microseconds ms: milliseconds s: seconds (default) m: minutes h: hours count: number of times to execute command command: command to execute (or text to send to buffer if command does not start with "/"), evaluated and the following variables are set each time the command is executed: ${buffer}: buffer pointer ${repeat_count}: number of times the command is executed ${repeat_index}: current index (from 1 to "count") ${repeat_index0}: current index (from 0 to "count" - 1) ${repeat_revindex}: current index from the end (from "count" to 1) ${repeat_revindex0}: current index from the end (from "count" - 1 to 0) ${repeat_first}: "1" for the first execution, "0" for the others ${repeat_last}: "1" for the last execution, "0" for the others Note: the command is executed on buffer where /repeat was executed (if the buffer does not exist anymore, the command is not executed). Examples: scroll 2 pages up: /repeat 2 /window page_up print a countdown, starting at 5: /repeat -interval 1 6 /print ${if:${repeat_last}?Boom!:${repeat_revindex0}}
-
reset
: reset config options
/reset <option> -mask <option> option: name of an option -mask: use a mask in option (wildcard "*" is allowed to mass-reset options, use carefully!) Examples: /reset weechat.look.item_time_format /reset -mask weechat.color.*
-
save
: save configuration files to disk
/save [<file>...] file: configuration file to save (without extension ".conf") Without argument, all files (WeeChat and plugins) are saved. By default all configuration files are saved to disk on /quit command (see option "weechat.look.save_config_on_exit").
-
secure
: manage secured data (passwords or private data encrypted in file sec.conf)
/secure passphrase <passphrase>|-delete decrypt <passphrase>|-discard set <name> <value> del <name> passphrase: change the passphrase (without passphrase, data is stored as plain text in file sec.conf) -delete: delete passphrase decrypt: decrypt data still encrypted (it happens only if passphrase was not given on startup) -discard: discard all data still encrypted set: add or change secured data del: delete secured data Without argument, this command displays secured data in a new buffer. Keys on secure buffer: alt+v toggle values When a passphrase is used (data encrypted), it is asked by WeeChat on startup. It is possible to set environment variable "WEECHAT_PASSPHRASE" to prevent the prompt (this same variable is used by WeeChat on /upgrade), or to set option sec.crypt.passphrase_command to read the passphrase from the output of an external command like a password manager (see /help sec.crypt.passphrase_command). Secured data with format ${sec.data.xxx} can be used in: - command /eval - command line argument "--run-command" - options weechat.startup.command_{before|after}_plugins - other options that may contain a password or sensitive data (for example proxy, irc server and relay); see /help on the options to check if they are evaluated. Examples: set a passphrase: /secure passphrase this is my passphrase use program "pass" to read the passphrase on startup: /set sec.crypt.passphrase_command "/usr/bin/pass show weechat/passphrase" encrypt libera SASL password: /secure set libera mypassword /set irc.server.libera.sasl_password "${sec.data.libera}" encrypt oftc password for nickserv: /secure set oftc mypassword /set irc.server.oftc.command "/msg nickserv identify ${sec.data.oftc}" alias to ghost the nick "mynick": /alias add ghost /eval /msg -server libera nickserv ghost mynick ${sec.data.libera}
-
set
: set config options and environment variables
/set [<option> [<value>]] diff [<option>...] env [<variable> [<value>]] option: name of an option (wildcard "*" is allowed to list options, if no value is specified) value: new value for option, according to type: boolean: on, off or toggle integer: number, ++number or --number string: any string ("" for empty string) color: color name, ++number or --number diff: display only changed options env: display or set an environment variable ("" to unset a variable) Note: the value "null" (without quotes) can be used to remove option value (undefined value). This works only for some special plugin variables. Examples: /set *highlight* /set weechat.look.highlight "word" /set diff /set diff irc.* /set env LANG /set env LANG fr_FR.UTF-8 /set env ABC ""
-
sys
: system actions
/sys get rlimit|rusage malloc_trim [<size>] suspend waitpid <number> get: display system info rlimit: display resource limits (see /help weechat.startup.sys_rlimit and "man getrlimit") rusage: display resource usage (see "man getrusage") malloc_trim: call function malloc_trim to release free memory from the heap size: amount of free space to leave untrimmed at the top of the heap (default is 0: only the minimum amount of memory is maintained at the top of the heap) suspend: suspend WeeChat and go back to the shell, by sending signal SIGTSTP to the WeeChat process waitpid: acknowledge the end of children processes (to prevent "zombie" processes) number: number of processes to clean
-
toggle
: toggle value of a config option
/toggle <option> [<value>...] option: name of an option value: possible values for the option (values are split like the shell command arguments: quotes can be used to preserve spaces at the beginning/end of values) Behavior: - only an option of type boolean or string can be toggled without a value: - boolean: toggle between on/off according to current value - string: toggle between empty string and default value (works only if empty string is allowed for the option) - with a single value given, toggle between this value and the default value of option - with multiple values given, toggle between these values: the value used is the one following the current value of option; if the current value of option is not in list, the first value in the list is used - the special value "null" can be given, but only as first value in the list and without quotes around. Examples: toggle display of time in chat area (without displaying the new value used): /mute /toggle weechat.look.buffer_time_format switch format of time in chat area (with seconds, without seconds, disabled): /toggle weechat.look.buffer_time_format "%H:%M:%S" "%H:%M" "" toggle autojoin of #weechat channel on libera server: /toggle irc.server.libera.autojoin null #weechat
-
unset
: unset/reset config options
/unset <option> -mask <option> option: name of an option -mask: use a mask in option (wildcard "*" is allowed to mass-reset options, use carefully!) According to option, it's reset (for standard options) or removed (for optional settings, like server values). Examples: /unset weechat.look.item_time_format /unset -mask weechat.color.*
-
upgrade
: save WeeChat session and reload the WeeChat binary without disconnecting from servers
/upgrade [-yes] [<path_to_binary>|-save|-quit] -o|-ol -yes: required if option "weechat.look.confirm_upgrade" is enabled path_to_binary: path to WeeChat binary (default is current binary) -dummy: do nothing (option used to prevent accidental completion with "-quit") -save: only save the session, neither quit nor reload WeeChat; the configuration files are not saved (if needed you can use /save before this command) -quit: close *ALL* connections, save session and quit WeeChat, which makes possible a delayed restoration (see below) -o: send number of upgrades and date of first/last start to current buffer as input (English string) -ol: send number of upgrades and date of first/last start to current buffer as input (translated string) 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: TLS connections are lost during upgrade (except with -save), because the reload of TLS sessions is currently not possible with GnuTLS. There is automatic reconnection after upgrade. Important: use of option "-save" can be dangerous, it is recommended to use only /upgrade (or with "-quit") for a standard upgrade and a restart; the option "-save" can be used to save the session regularly and restore it in case of after abnormal exit (power outage, crash, etc.). 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. With option "-quit", the process is: 1. close *ALL* connections (irc, xfer, relay, ...) 2. save session into files (*.upgrade) 3. unload all plugins 4. save WeeChat configuration 5. quit WeeChat With option "-save", the process is: 1. save session into files (*.upgrade) with a disconnected state for IRC servers and Relay clients (but no disconnection is made) With -quit or -save, you can restore the session later with this command: weechat --upgrade IMPORTANT: you must restore the session with exactly same configuration (files *.conf) and if possible the same WeeChat version (or a more recent one). It is possible to restore WeeChat session on another machine if you copy the content of WeeChat home directories (see /debug dirs).
-
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) The default alias /v can be used to execute this command on all buffers (otherwise the irc command /version is used on irc buffers).
-
wait
: schedule a command execution in future
/wait <number>[<unit>] <command> number: amount of time to wait (minimum: 1 millisecond) unit: optional, values are: us: microseconds 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: the command is executed on buffer where /wait was executed (if the buffer does not exist anymore, the command is not executed). Examples: join channel #test 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>] [h|v][+|-]<pct> balance merge [-window <number>] [all] close [-window <number>] 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_beyond_end|scroll_previous_highlight|scroll_next_highlight|scroll_unread [-window <number>] swap [-window <number>] [up|down|left|right] zoom [-window <number>] bare [<delay>] 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 (to undo: /window merge) splitv: split current window vertically (to undo: /window merge) resize: resize window size, new size is <pct> percentage of parent window; if "h" or "v" is specified, the resize affects the nearest parent window with a split of this type (horizontal/vertical) balance: balance the sizes of all windows merge: merge window with another (all = keep only one window) close: close 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_beyond_end: scroll beyond the end 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 bare: toggle bare display (with optional delay in seconds for automatic return to standard display mode) 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: /window b1 /window scroll -2 /window scroll -2d /window scroll -d /window zoom -window 2 /window splith 30 /window resize 75 /window resize v+10 /window bare 2
Secured data options
Sections in file sec.conf:
Section | Control command | Description |
---|---|---|
|
|
Options for encryption. |
|
Secured data. |
Options:
-
-
description: cipher used to crypt data (the number after algorithm is the size of the key in bits)
-
type: enum
-
values: aes128, aes192, aes256
-
default value:
aes256
-
-
-
description: hash algorithm used to check the decrypted data; some of them require a specific libgcrypt version: sha3-*: libgcrypt >= 1.7.0, blake2*: libgcrypt >= 1.8.0, sha512-*: libgcrypt >= 1.9.4
-
type: enum
-
values: sha224, sha256, sha384, sha512, sha512-224, sha512-256, sha3-224, sha3-256, sha3-384, sha3-512, blake2b-160, blake2b-256, blake2b-384, blake2b-512, blake2s-128, blake2s-160, blake2s-224, blake2s-256
-
default value:
sha256
-
-
-
description: read the passphrase from the output of this system command (only the first line is used and it must not contain any extra character); this option is used only when reading file sec.conf and if the environment variable "WEECHAT_PASSPHRASE" is not set (the environment variable has higher priority); example with password-store: "/usr/bin/pass show weechat/passphrase"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: use salt when generating key used in encryption (recommended for maximum security); when enabled, the content of crypted data in file sec.conf will be different on each write of the file; if you put the file sec.conf in a version control system, then you can turn off this option to have always same content in file
-
type: boolean
-
values: on, off
-
default value:
on
-
WeeChat options
Sections in file weechat.conf:
Section | Control command | Description |
---|---|---|
|
|
Debug level, for core and plugins (options can be added/removed in section). |
|
|
Startup options. |
|
|
Look and feel. |
|
|
Color aliases (options can be added/removed in section). |
|
|
Colors. |
|
|
Completion options. |
|
|
History options (commands and buffers). |
|
|
Proxy options. |
|
|
Network/TLS options. |
|
|
Options on plugins. |
|
|
Options on signals. |
|
|
Bar options. |
|
Layouts. |
|
|
Properties auto-applied on buffers when they are opened. |
|
|
Notify levels for buffers (options can be added/removed in section). |
|
|
Filters. |
|
|
Keys in default context. |
|
|
Keys in search context. |
|
|
Keys in cursor context. |
|
|
Keys in mouse context. |
Options:
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightmagenta
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: text color for message displayed when the day has 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
22
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
124
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
240
-
-
-
description: text color for nicks in chat window: used in some server messages and as fallback when a nick color is not found; most of times nick color comes from option weechat.color.chat_nick_colors
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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,lightcyan,lightmagenta,lightgreen,31,35,38,40,49,63,70,80,92,99,112,126,130,138,142,148,160,162,167,169,174,176,178,184,186,210,212,215,248"
-
-
weechat.color.chat_nick_offline
-
description: text color for offline nick (not in nicklist anymore); this color is used only if option weechat.look.color_nick_offline is enabled
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
242
-
-
weechat.color.chat_nick_offline_highlight
-
description: text color for offline nick with highlight; this color is used only if option weechat.look.color_nick_offline is enabled
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
weechat.color.chat_nick_offline_highlight_bg
-
description: background color for offline nick with highlight; this color is used only if option weechat.look.color_nick_offline is enabled
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
17
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
weechat.color.chat_nick_prefix
-
description: color for nick prefix (string displayed before nick in 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
weechat.color.chat_nick_suffix
-
description: color for nick suffix (string displayed after nick in 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
180
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
24
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
weechat.color.chat_status_disabled
-
description: text color for "disabled" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
red
-
-
weechat.color.chat_status_enabled
-
description: text color for "enabled" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
red
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightmagenta
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
-
description: text color for null values (undefined)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
blue
-
-
-
description: text color for emphasized text (for example when searching text); this option is used only if option weechat.look.emphasized_attributes is an empty string (default value)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: background color for emphasized text (for example when searching text); used only if option weechat.look.emphasized_attributes is an empty string (default value)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
54
-
-
weechat.color.eval_syntax_colors
-
description: text color for syntax highlighting in evaluated strings, with "${raw_hl:...}" and "${hl:...}" (comma separated list of colors, background is allowed with format: "fg:bg", for example: "lightred:blue")
-
type: string
-
values: any string
-
default value:
"green,lightred,lightblue,lightmagenta,yellow,cyan"
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
red
-
-
-
description: text 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
240
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
-
description: color for window separators (when split) and separators beside bars (like 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
236
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightmagenta
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightgreen
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
-
description: text color for buffer modes 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: text color for mouse 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightgreen
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
weechat.color.status_name_insecure
-
description: text color for current buffer name in status bar, if data are exchanged and not secured with a protocol like TLS
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightmagenta
-
-
-
description: text color for current buffer name in status bar, if data are exchanged and secured with a protocol like TLS
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
weechat.color.status_nicklist_count
-
description: text color for number of nicks in nicklist (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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" 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.case_sensitive
-
description: if enabled, the completion is case-sensitive by default
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.completion.command_inline
-
description: if enabled, the commands inside command line are completed (the command at beginning of line has higher priority and is used first); note: when this option is enabled, there is no more automatic completion of paths beginning with "/" (outside commands arguments)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.completion.default_template
-
description: default completion template (please see documentation for template codes and values: plugin API reference, function "weechat_hook_command")
-
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_case_sensitive
-
description: case-sensitive completion for nicks
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.completion.nick_completer
-
description: string inserted after nick completion (when nick is first word on command line)
-
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: send alert (BEL) 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.completion.partial_completion_templates
-
description: comma-separated list of templates for which partial completion is enabled by default (with Tab key instead of shift-Tab); the list of templates is in documentation: plugin API reference, function "weechat_hook_command"
-
type: string
-
values: any string
-
default value:
"config_options"
-
-
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; use 0 ONLY if option weechat.history.max_buffer_lines_number is NOT set to 0
-
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); use 0 ONLY if option weechat.history.max_buffer_lines_minutes is NOT set to 0
-
type: integer
-
values: 0 .. 2147483647
-
default value:
4096
-
-
-
description: maximum number of user commands in history (0 = unlimited, NOT RECOMMENDED: no limit in memory usage)
-
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
-
-
-
description: "backspace" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_previous_char"
-
-
-
description: "ctrl-_" (default)
-
type: string
-
values: any string
-
default value:
"/input undo"
-
-
-
description: "ctrl-a" (default)
-
type: string
-
values: any string
-
default value:
"/input move_beginning_of_line"
-
-
-
description: "ctrl-b" (default)
-
type: string
-
values: any string
-
default value:
"/input move_previous_char"
-
-
-
description: "ctrl-c,_" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x1F"
-
-
-
description: "ctrl-c,b" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x02"
-
-
-
description: "ctrl-c,c" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x03"
-
-
-
description: "ctrl-c,d" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x04"
-
-
-
description: "ctrl-c,i" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x1D"
-
-
-
description: "ctrl-c,o" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x0F"
-
-
-
description: "ctrl-c,v" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \x16"
-
-
-
description: "ctrl-d" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_next_char"
-
-
-
description: "ctrl-down" (default)
-
type: string
-
values: any string
-
default value:
"/input history_global_next"
-
-
-
description: "ctrl-e" (default)
-
type: string
-
values: any string
-
default value:
"/input move_end_of_line"
-
-
-
description: "ctrl-f" (default)
-
type: string
-
values: any string
-
default value:
"/input move_next_char"
-
-
-
description: "ctrl-f1" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll buflist * -100%"
-
-
-
description: "ctrl-f11" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist * -100%"
-
-
-
description: "ctrl-f12" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist * +100%"
-
-
-
description: "ctrl-f2" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll buflist * +100%"
-
-
-
description: "ctrl-k" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_end_of_line"
-
-
-
description: "ctrl-l" (default)
-
type: string
-
values: any string
-
default value:
"/window refresh"
-
-
-
description: "ctrl-left" (default)
-
type: string
-
values: any string
-
default value:
"/input move_previous_word"
-
-
-
description: "ctrl-n" (default)
-
type: string
-
values: any string
-
default value:
"/buffer +1"
-
-
-
description: "ctrl-o" (default)
-
type: string
-
values: any string
-
default value:
"/input history_use_get_next"
-
-
-
description: "ctrl-p" (default)
-
type: string
-
values: any string
-
default value:
"/buffer -1"
-
-
-
description: "ctrl-r" (default)
-
type: string
-
values: any string
-
default value:
"/input search_history"
-
-
-
description: "ctrl-right" (default)
-
type: string
-
values: any string
-
default value:
"/input move_next_word"
-
-
-
description: "ctrl-s" (default)
-
type: string
-
values: any string
-
default value:
"/input search_text_here"
-
-
-
description: "ctrl-t" (default)
-
type: string
-
values: any string
-
default value:
"/input transpose_chars"
-
-
-
description: "ctrl-u" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_beginning_of_line"
-
-
-
description: "ctrl-up" (default)
-
type: string
-
values: any string
-
default value:
"/input history_global_previous"
-
-
-
description: "ctrl-w" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_previous_word_whitespace"
-
-
-
description: "ctrl-x" (default)
-
type: string
-
values: any string
-
default value:
"/buffer switch"
-
-
-
description: "ctrl-y" (default)
-
type: string
-
values: any string
-
default value:
"/input clipboard_paste"
-
-
-
description: "ctrl-z" (default)
-
type: string
-
values: any string
-
default value:
"/sys suspend"
-
-
-
description: "delete" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_next_char"
-
-
-
description: "down" (default)
-
type: string
-
values: any string
-
default value:
"/input history_next"
-
-
-
description: "end" (default)
-
type: string
-
values: any string
-
default value:
"/input move_end_of_line"
-
-
-
description: "f1" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll buflist * -100%"
-
-
-
description: "f10" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll title * +30%"
-
-
-
description: "f11" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist * -100%"
-
-
-
description: "f12" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist * +100%"
-
-
-
description: "f2" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll buflist * +100%"
-
-
-
description: "f5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer -1"
-
-
-
description: "f6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer +1"
-
-
-
description: "f7" (default)
-
type: string
-
values: any string
-
default value:
"/window -1"
-
-
-
description: "f8" (default)
-
type: string
-
values: any string
-
default value:
"/window +1"
-
-
-
description: "f9" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll title * -30%"
-
-
-
description: "home" (default)
-
type: string
-
values: any string
-
default value:
"/input move_beginning_of_line"
-
-
-
description: "left" (default)
-
type: string
-
values: any string
-
default value:
"/input move_previous_char"
-
-
-
description: "meta--" (default)
-
type: string
-
values: any string
-
default value:
"/filter toggle @"
-
-
[[option_weechat.key.meta-/]] weechat.key.meta-/
-
description: "meta-/" (default)
-
type: string
-
values: any string
-
default value:
"/buffer jump last_displayed"
-
-
-
description: "meta-0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *10"
-
-
-
description: "meta-1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *1"
-
-
-
description: "meta-2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *2"
-
-
-
description: "meta-3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *3"
-
-
-
description: "meta-4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *4"
-
-
-
description: "meta-5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *5"
-
-
-
description: "meta-6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *6"
-
-
-
description: "meta-7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *7"
-
-
-
description: "meta-8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *8"
-
-
-
description: "meta-9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *9"
-
-
[[option_weechat.key.meta-<]] weechat.key.meta-<
-
description: "meta-<" (default)
-
type: string
-
values: any string
-
default value:
"/buffer jump prev_visited"
-
-
[[option_weechat.key.meta-=]] weechat.key.meta-=
-
description: "meta-=" (default)
-
type: string
-
values: any string
-
default value:
"/filter toggle"
-
-
[[option_weechat.key.meta→]] weechat.key.meta->
-
description: "meta->" (default)
-
type: string
-
values: any string
-
default value:
"/buffer jump next_visited"
-
-
-
description: "meta-B" (default)
-
type: string
-
values: any string
-
default value:
"/buflist toggle"
-
-
-
description: "meta-N" (default)
-
type: string
-
values: any string
-
default value:
"/bar toggle nicklist"
-
-
-
description: "meta-R" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_input"
-
-
-
description: "meta-U" (default)
-
type: string
-
values: any string
-
default value:
"/allbuf /buffer set unread"
-
-
-
description: "meta-_" (default)
-
type: string
-
values: any string
-
default value:
"/input redo"
-
-
-
description: "meta-a" (default)
-
type: string
-
values: any string
-
default value:
"/buffer jump smart"
-
-
-
description: "meta-b" (default)
-
type: string
-
values: any string
-
default value:
"/input move_previous_word"
-
-
-
description: "meta-backspace" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_previous_word"
-
-
-
description: "meta-ctrl-k" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_end_of_input"
-
-
-
description: "meta-ctrl-u" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_beginning_of_input"
-
-
-
description: "meta-d" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_next_word"
-
-
-
description: "meta-down" (default)
-
type: string
-
values: any string
-
default value:
"/buffer +1"
-
-
-
description: "meta-end" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_bottom"
-
-
-
description: "meta-f" (default)
-
type: string
-
values: any string
-
default value:
"/input move_next_word"
-
-
-
description: "meta-f1" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll buflist * b"
-
-
-
description: "meta-f11" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist * b"
-
-
-
description: "meta-f12" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist * e"
-
-
-
description: "meta-f2" (default)
-
type: string
-
values: any string
-
default value:
"/bar scroll buflist * e"
-
-
-
description: "meta-h,meta-R" (default)
-
type: string
-
values: any string
-
default value:
"/hotlist restore -all"
-
-
-
description: "meta-h,meta-c" (default)
-
type: string
-
values: any string
-
default value:
"/hotlist clear"
-
-
-
description: "meta-h,meta-m" (default)
-
type: string
-
values: any string
-
default value:
"/hotlist remove"
-
-
-
description: "meta-h,meta-r" (default)
-
type: string
-
values: any string
-
default value:
"/hotlist restore"
-
-
-
description: "meta-home" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_top"
-
-
-
description: "meta-j,0,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *1"
-
-
-
description: "meta-j,0,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *2"
-
-
-
description: "meta-j,0,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *3"
-
-
-
description: "meta-j,0,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *4"
-
-
-
description: "meta-j,0,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *5"
-
-
-
description: "meta-j,0,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *6"
-
-
-
description: "meta-j,0,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *7"
-
-
-
description: "meta-j,0,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *8"
-
-
-
description: "meta-j,0,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *9"
-
-
-
description: "meta-j,1,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *10"
-
-
-
description: "meta-j,1,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *11"
-
-
-
description: "meta-j,1,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *12"
-
-
-
description: "meta-j,1,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *13"
-
-
-
description: "meta-j,1,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *14"
-
-
-
description: "meta-j,1,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *15"
-
-
-
description: "meta-j,1,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *16"
-
-
-
description: "meta-j,1,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *17"
-
-
-
description: "meta-j,1,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *18"
-
-
-
description: "meta-j,1,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *19"
-
-
-
description: "meta-j,2,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *20"
-
-
-
description: "meta-j,2,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *21"
-
-
-
description: "meta-j,2,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *22"
-
-
-
description: "meta-j,2,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *23"
-
-
-
description: "meta-j,2,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *24"
-
-
-
description: "meta-j,2,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *25"
-
-
-
description: "meta-j,2,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *26"
-
-
-
description: "meta-j,2,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *27"
-
-
-
description: "meta-j,2,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *28"
-
-
-
description: "meta-j,2,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *29"
-
-
-
description: "meta-j,3,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *30"
-
-
-
description: "meta-j,3,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *31"
-
-
-
description: "meta-j,3,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *32"
-
-
-
description: "meta-j,3,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *33"
-
-
-
description: "meta-j,3,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *34"
-
-
-
description: "meta-j,3,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *35"
-
-
-
description: "meta-j,3,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *36"
-
-
-
description: "meta-j,3,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *37"
-
-
-
description: "meta-j,3,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *38"
-
-
-
description: "meta-j,3,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *39"
-
-
-
description: "meta-j,4,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *40"
-
-
-
description: "meta-j,4,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *41"
-
-
-
description: "meta-j,4,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *42"
-
-
-
description: "meta-j,4,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *43"
-
-
-
description: "meta-j,4,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *44"
-
-
-
description: "meta-j,4,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *45"
-
-
-
description: "meta-j,4,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *46"
-
-
-
description: "meta-j,4,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *47"
-
-
-
description: "meta-j,4,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *48"
-
-
-
description: "meta-j,4,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *49"
-
-
-
description: "meta-j,5,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *50"
-
-
-
description: "meta-j,5,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *51"
-
-
-
description: "meta-j,5,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *52"
-
-
-
description: "meta-j,5,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *53"
-
-
-
description: "meta-j,5,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *54"
-
-
-
description: "meta-j,5,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *55"
-
-
-
description: "meta-j,5,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *56"
-
-
-
description: "meta-j,5,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *57"
-
-
-
description: "meta-j,5,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *58"
-
-
-
description: "meta-j,5,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *59"
-
-
-
description: "meta-j,6,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *60"
-
-
-
description: "meta-j,6,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *61"
-
-
-
description: "meta-j,6,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *62"
-
-
-
description: "meta-j,6,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *63"
-
-
-
description: "meta-j,6,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *64"
-
-
-
description: "meta-j,6,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *65"
-
-
-
description: "meta-j,6,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *66"
-
-
-
description: "meta-j,6,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *67"
-
-
-
description: "meta-j,6,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *68"
-
-
-
description: "meta-j,6,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *69"
-
-
-
description: "meta-j,7,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *70"
-
-
-
description: "meta-j,7,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *71"
-
-
-
description: "meta-j,7,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *72"
-
-
-
description: "meta-j,7,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *73"
-
-
-
description: "meta-j,7,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *74"
-
-
-
description: "meta-j,7,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *75"
-
-
-
description: "meta-j,7,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *76"
-
-
-
description: "meta-j,7,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *77"
-
-
-
description: "meta-j,7,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *78"
-
-
-
description: "meta-j,7,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *79"
-
-
-
description: "meta-j,8,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *80"
-
-
-
description: "meta-j,8,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *81"
-
-
-
description: "meta-j,8,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *82"
-
-
-
description: "meta-j,8,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *83"
-
-
-
description: "meta-j,8,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *84"
-
-
-
description: "meta-j,8,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *85"
-
-
-
description: "meta-j,8,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *86"
-
-
-
description: "meta-j,8,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *87"
-
-
-
description: "meta-j,8,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *88"
-
-
-
description: "meta-j,8,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *89"
-
-
-
description: "meta-j,9,0" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *90"
-
-
-
description: "meta-j,9,1" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *91"
-
-
-
description: "meta-j,9,2" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *92"
-
-
-
description: "meta-j,9,3" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *93"
-
-
-
description: "meta-j,9,4" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *94"
-
-
-
description: "meta-j,9,5" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *95"
-
-
-
description: "meta-j,9,6" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *96"
-
-
-
description: "meta-j,9,7" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *97"
-
-
-
description: "meta-j,9,8" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *98"
-
-
-
description: "meta-j,9,9" (default)
-
type: string
-
values: any string
-
default value:
"/buffer *99"
-
-
-
description: "meta-j,meta-f" (default)
-
type: string
-
values: any string
-
default value:
"/buffer -"
-
-
-
description: "meta-j,meta-l" (default)
-
type: string
-
values: any string
-
default value:
"/buffer +"
-
-
-
description: "meta-j,meta-r" (default)
-
type: string
-
values: any string
-
default value:
"/server raw"
-
-
-
description: "meta-j,meta-s" (default)
-
type: string
-
values: any string
-
default value:
"/server jump"
-
-
-
description: "meta-k" (default)
-
type: string
-
values: any string
-
default value:
"/input grab_key_command"
-
-
-
description: "meta-l" (default)
-
type: string
-
values: any string
-
default value:
"/window bare"
-
-
-
description: "meta-left" (default)
-
type: string
-
values: any string
-
default value:
"/buffer -1"
-
-
-
description: "meta-m" (default)
-
type: string
-
values: any string
-
default value:
"/mute mouse toggle"
-
-
-
description: "meta-n" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_next_highlight"
-
-
-
description: "meta-p" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_previous_highlight"
-
-
-
description: "meta-pgdn" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_down"
-
-
-
description: "meta-pgup" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_up"
-
-
-
description: "meta-r" (default)
-
type: string
-
values: any string
-
default value:
"/input delete_line"
-
-
-
description: "meta-return" (default)
-
type: string
-
values: any string
-
default value:
"/input insert \n"
-
-
-
description: "meta-right" (default)
-
type: string
-
values: any string
-
default value:
"/buffer +1"
-
-
-
description: "meta-s" (default)
-
type: string
-
values: any string
-
default value:
"/mute spell toggle"
-
-
-
description: "meta-u" (default)
-
type: string
-
values: any string
-
default value:
"/window scroll_unread"
-
-
-
description: "meta-up" (default)
-
type: string
-
values: any string
-
default value:
"/buffer -1"
-
-
-
description: "meta-w,meta-b" (default)
-
type: string
-
values: any string
-
default value:
"/window balance"
-
-
-
description: "meta-w,meta-down" (default)
-
type: string
-
values: any string
-
default value:
"/window down"
-
-
-
description: "meta-w,meta-left" (default)
-
type: string
-
values: any string
-
default value:
"/window left"
-
-
-
description: "meta-w,meta-right" (default)
-
type: string
-
values: any string
-
default value:
"/window right"
-
-
-
description: "meta-w,meta-s" (default)
-
type: string
-
values: any string
-
default value:
"/window swap"
-
-
-
description: "meta-w,meta-up" (default)
-
type: string
-
values: any string
-
default value:
"/window up"
-
-
-
description: "meta-x" (default)
-
type: string
-
values: any string
-
default value:
"/buffer zoom"
-
-
-
description: "meta-z" (default)
-
type: string
-
values: any string
-
default value:
"/window zoom"
-
-
-
description: "pgdn" (default)
-
type: string
-
values: any string
-
default value:
"/window page_down"
-
-
-
description: "pgup" (default)
-
type: string
-
values: any string
-
default value:
"/window page_up"
-
-
-
description: "return" (default)
-
type: string
-
values: any string
-
default value:
"/input return"
-
-
-
description: "right" (default)
-
type: string
-
values: any string
-
default value:
"/input move_next_char"
-
-
-
description: "shift-down" (default)
-
type: string
-
values: any string
-
default value:
"/input move_next_line"
-
-
-
description: "shift-end" (default)
-
type: string
-
values: any string
-
default value:
"/input move_end_of_input"
-
-
-
description: "shift-home" (default)
-
type: string
-
values: any string
-
default value:
"/input move_beginning_of_input"
-
-
-
description: "shift-left" (default)
-
type: string
-
values: any string
-
default value:
"/input move_previous_char"
-
-
-
description: "shift-right" (default)
-
type: string
-
values: any string
-
default value:
"/input move_next_char"
-
-
-
description: "shift-tab" (default)
-
type: string
-
values: any string
-
default value:
"/input complete_previous"
-
-
-
description: "shift-up" (default)
-
type: string
-
values: any string
-
default value:
"/input move_previous_line"
-
-
-
description: "tab" (default)
-
type: string
-
values: any string
-
default value:
"/input complete_next"
-
-
-
description: "up" (default)
-
type: string
-
values: any string
-
default value:
"/input history_previous"
-
-
-
description: "@chat:Q" (cursor)
-
type: string
-
values: any string
-
default value:
"hsignal:chat_quote_time_prefix_message;/cursor stop"
-
-
-
description: "@chat:l" (cursor)
-
type: string
-
values: any string
-
default value:
"hsignal:chat_quote_focused_line;/cursor stop"
-
-
-
description: "@chat:m" (cursor)
-
type: string
-
values: any string
-
default value:
"hsignal:chat_quote_message;/cursor stop"
-
-
-
description: "@chat:q" (cursor)
-
type: string
-
values: any string
-
default value:
"hsignal:chat_quote_prefix_message;/cursor stop"
-
-
weechat.key_cursor.@item(buffer_nicklist):K
-
description: "@item(buffer_nicklist):K" (cursor)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/kickban ${nick}"
-
-
weechat.key_cursor.@item(buffer_nicklist):b
-
description: "@item(buffer_nicklist):b" (cursor)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/ban ${nick}"
-
-
weechat.key_cursor.@item(buffer_nicklist):k
-
description: "@item(buffer_nicklist):k" (cursor)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/kick ${nick}"
-
-
weechat.key_cursor.@item(buffer_nicklist):q
-
description: "@item(buffer_nicklist):q" (cursor)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/query ${nick};/cursor stop"
-
-
weechat.key_cursor.@item(buffer_nicklist):w
-
description: "@item(buffer_nicklist):w" (cursor)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/whois ${nick}"
-
-
-
description: "down" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move down"
-
-
-
description: "left" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move left"
-
-
-
description: "meta-down" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move edge_bottom"
-
-
-
description: "meta-end" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move bottom_right"
-
-
-
description: "meta-home" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move top_left"
-
-
-
description: "meta-left" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move edge_left"
-
-
-
description: "meta-right" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move edge_right"
-
-
weechat.key_cursor.meta-shift-down
-
description: "meta-shift-down" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move area_down"
-
-
weechat.key_cursor.meta-shift-left
-
description: "meta-shift-left" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move area_left"
-
-
weechat.key_cursor.meta-shift-right
-
description: "meta-shift-right" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move area_right"
-
-
weechat.key_cursor.meta-shift-up
-
description: "meta-shift-up" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move area_up"
-
-
-
description: "meta-up" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move edge_top"
-
-
-
description: "return" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor stop"
-
-
-
description: "right" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move right"
-
-
-
description: "up" (cursor)
-
type: string
-
values: any string
-
default value:
"/cursor move up"
-
-
-
description: "ctrl-o" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input history_use_get_next"
-
-
-
description: "ctrl-q" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_stop"
-
-
-
description: "ctrl-r" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_previous"
-
-
-
description: "ctrl-s" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_next"
-
-
-
description: "ctrl-x" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_switch_regex"
-
-
-
description: "down" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_next"
-
-
-
description: "meta-c" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_switch_case"
-
-
-
description: "return" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_stop_here"
-
-
-
description: "tab" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_switch_where"
-
-
-
description: "up" (histsearch)
-
type: string
-
values: any string
-
default value:
"/input search_previous"
-
-
-
description: "@*:button3" (mouse)
-
type: string
-
values: any string
-
default value:
"/cursor go ${_x},${_y}"
-
-
weechat.key_mouse.@bar(buflist):ctrl-wheeldown
-
description: "@bar(buflist):ctrl-wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@bar(buflist):ctrl-wheelup
-
description: "@bar(buflist):ctrl-wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@bar(input):button2
-
description: "@bar(input):button2" (mouse)
-
type: string
-
values: any string
-
default value:
"/input grab_mouse_area"
-
-
weechat.key_mouse.@bar(nicklist):button1-gesture-down
-
description: "@bar(nicklist):button1-gesture-down" (mouse)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist ${_window_number} +100%"
-
-
weechat.key_mouse.@bar(nicklist):button1-gesture-down-long
-
description: "@bar(nicklist):button1-gesture-down-long" (mouse)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist ${_window_number} e"
-
-
weechat.key_mouse.@bar(nicklist):button1-gesture-up
-
description: "@bar(nicklist):button1-gesture-up" (mouse)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist ${_window_number} -100%"
-
-
weechat.key_mouse.@bar(nicklist):button1-gesture-up-long
-
description: "@bar(nicklist):button1-gesture-up-long" (mouse)
-
type: string
-
values: any string
-
default value:
"/bar scroll nicklist ${_window_number} b"
-
-
weechat.key_mouse.@bar:wheeldown
-
description: "@bar:wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"/bar scroll ${_bar_name} ${_window_number} +20%"
-
-
weechat.key_mouse.@bar:wheelup
-
description: "@bar:wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"/bar scroll ${_bar_name} ${_window_number} -20%"
-
-
weechat.key_mouse.@chat(fset.fset):button1
-
description: "@chat(fset.fset):button1" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/fset -go ${fset_option_index}"
-
-
weechat.key_mouse.@chat(fset.fset):button2*
-
description: "@chat(fset.fset):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:fset_mouse"
-
-
weechat.key_mouse.@chat(fset.fset):wheeldown
-
description: "@chat(fset.fset):wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"/fset -down 5"
-
-
weechat.key_mouse.@chat(fset.fset):wheelup
-
description: "@chat(fset.fset):wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"/fset -up 5"
-
-
weechat.key_mouse.@chat(irc.list_*):button1
-
description: "@chat(irc.list_*):button1" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/list -go ${_chat_line_y}"
-
-
weechat.key_mouse.@chat(irc.list_*):button2*
-
description: "@chat(irc.list_*):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:irc_list_mouse"
-
-
weechat.key_mouse.@chat(irc.list_*):wheeldown
-
description: "@chat(irc.list_*):wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"/list -down 5"
-
-
weechat.key_mouse.@chat(irc.list_*):wheelup
-
description: "@chat(irc.list_*):wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"/list -up 5"
-
-
weechat.key_mouse.@chat(script.scripts):button1
-
description: "@chat(script.scripts):button1" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/script -go ${_chat_line_y}"
-
-
weechat.key_mouse.@chat(script.scripts):button2
-
description: "@chat(script.scripts):button2" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/script -go ${_chat_line_y};/script installremove -q ${script_name_with_extension}"
-
-
weechat.key_mouse.@chat(script.scripts):wheeldown
-
description: "@chat(script.scripts):wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"/script -down 5"
-
-
weechat.key_mouse.@chat(script.scripts):wheelup
-
description: "@chat(script.scripts):wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"/script -up 5"
-
-
weechat.key_mouse.@chat:button1
-
description: "@chat:button1" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number}"
-
-
weechat.key_mouse.@chat:button1-gesture-left
-
description: "@chat:button1-gesture-left" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/buffer -1"
-
-
weechat.key_mouse.@chat:button1-gesture-left-long
-
description: "@chat:button1-gesture-left-long" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/buffer 1"
-
-
weechat.key_mouse.@chat:button1-gesture-right
-
description: "@chat:button1-gesture-right" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/buffer +1"
-
-
weechat.key_mouse.@chat:button1-gesture-right-long
-
description: "@chat:button1-gesture-right-long" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/buffer +"
-
-
weechat.key_mouse.@chat:ctrl-wheeldown
-
description: "@chat:ctrl-wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"/window scroll_horiz -window ${_window_number} +10%"
-
-
weechat.key_mouse.@chat:ctrl-wheelup
-
description: "@chat:ctrl-wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"/window scroll_horiz -window ${_window_number} -10%"
-
-
weechat.key_mouse.@chat:wheeldown
-
description: "@chat:wheeldown" (mouse)
-
type: string
-
values: any string
-
default value:
"/window scroll_down -window ${_window_number}"
-
-
weechat.key_mouse.@chat:wheelup
-
description: "@chat:wheelup" (mouse)
-
type: string
-
values: any string
-
default value:
"/window scroll_up -window ${_window_number}"
-
-
weechat.key_mouse.@item(buffer_nicklist):button1
-
description: "@item(buffer_nicklist):button1" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/query ${nick}"
-
-
weechat.key_mouse.@item(buffer_nicklist):button1-gesture-left
-
description: "@item(buffer_nicklist):button1-gesture-left" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/kick ${nick}"
-
-
weechat.key_mouse.@item(buffer_nicklist):button1-gesture-left-long
-
description: "@item(buffer_nicklist):button1-gesture-left-long" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/kickban ${nick}"
-
-
weechat.key_mouse.@item(buffer_nicklist):button2
-
description: "@item(buffer_nicklist):button2" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/whois ${nick}"
-
-
weechat.key_mouse.@item(buffer_nicklist):button2-gesture-left
-
description: "@item(buffer_nicklist):button2-gesture-left" (mouse)
-
type: string
-
values: any string
-
default value:
"/window ${_window_number};/ban ${nick}"
-
-
weechat.key_mouse.@item(buflist):button1*
-
description: "@item(buflist):button1*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist):button2*
-
description: "@item(buflist):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist2):button1*
-
description: "@item(buflist2):button1*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist2):button2*
-
description: "@item(buflist2):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist3):button1*
-
description: "@item(buflist3):button1*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist3):button2*
-
description: "@item(buflist3):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist4):button1*
-
description: "@item(buflist4):button1*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist4):button2*
-
description: "@item(buflist4):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist5):button1*
-
description: "@item(buflist5):button1*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
weechat.key_mouse.@item(buflist5):button2*
-
description: "@item(buflist5):button2*" (mouse)
-
type: string
-
values: any string
-
default value:
"hsignal:buflist_mouse"
-
-
-
description: "ctrl-q" (search)
-
type: string
-
values: any string
-
default value:
"/input search_stop"
-
-
-
description: "ctrl-r" (search)
-
type: string
-
values: any string
-
default value:
"/input search_previous"
-
-
-
description: "ctrl-s" (search)
-
type: string
-
values: any string
-
default value:
"/input search_next"
-
-
-
description: "ctrl-x" (search)
-
type: string
-
values: any string
-
default value:
"/input search_switch_regex"
-
-
-
description: "down" (search)
-
type: string
-
values: any string
-
default value:
"/input search_next"
-
-
-
description: "meta-c" (search)
-
type: string
-
values: any string
-
default value:
"/input search_switch_case"
-
-
-
description: "return" (search)
-
type: string
-
values: any string
-
default value:
"/input search_stop_here"
-
-
-
description: "tab" (search)
-
type: string
-
values: any string
-
default value:
"/input search_switch_where"
-
-
-
description: "up" (search)
-
type: string
-
values: any string
-
default value:
"/input search_previous"
-
-
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: enum
-
values: time, buffer, prefix, suffix, message
-
default value:
message
-
-
weechat.look.align_multiline_words
-
description: alignment for multiline words according to option weechat.look.align_end_of_lines; if disabled, the multiline words will not be aligned, which can be useful to not break long URLs
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: string displayed when bar can be scrolled down (for bars with filling different from "horizontal")
-
type: string
-
values: any string
-
default value:
"+"+
-
-
-
description: string displayed when bar can be scrolled to the left (for bars with filling "horizontal")
-
type: string
-
values: any string
-
default value:
"<<"
-
-
-
description: string displayed when bar can be scrolled to the right (for bars with filling "horizontal")
-
type: string
-
values: any string
-
default value:
">>"
-
-
-
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.bare_display_exit_on_input
-
description: exit the bare display mode on any changes in input
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.look.bare_display_time_format
-
description: time format in bare display mode (see API man strftime for date/time specifiers, extra specifiers are supported, see function util_strftimeval in Plugin API reference)
-
type: string
-
values: any string
-
default value:
"%H:%M"
-
-
weechat.look.buffer_auto_renumber
-
description: automatically renumber buffers to have only consecutive numbers and start with number 1; if disabled, gaps between buffer numbers are allowed and the first buffer can have a number greater than 1
-
type: boolean
-
values: on, off
-
default value:
on
-
-
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: enum
-
values: none, highlight, message, all
-
default value:
all
-
-
-
description: position of a new buffer: end = after the end of list (number = last number + 1) (default), first_gap = at first available number in the list (after the end of list if no number is available); this option is used only if the buffer has no layout number
-
type: enum
-
values: end, first_gap
-
default value:
end
-
-
weechat.look.buffer_search_case_sensitive
-
description: default text search in buffer: case-sensitive or not
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.look.buffer_search_force_default
-
description: force default values for text search in buffer (instead of using values from last search in buffer)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.look.buffer_search_history
-
description: default text search command line history: local (buffer) or global history
-
type: enum
-
values: local, global
-
default value:
local
-
-
weechat.look.buffer_search_regex
-
description: default text search in buffer: if enabled, search POSIX extended regular expression, otherwise search simple string
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.look.buffer_search_where
-
description: default text search in buffer: in message, prefix, prefix and message
-
type: enum
-
values: prefix, message, prefix_message
-
default value:
prefix_message
-
-
weechat.look.buffer_time_format
-
description: time format for each line displayed in buffers (see man strftime for date/time specifiers, extra specifiers are supported, see function util_strftimeval in Plugin API reference) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval); variable "${highlight}" can be used in a condition to have a format specific to lines with highlight (see also option weechat.look.highlight_prefix); for example time using grayscale: "${color:252}%H${color:243}%M${color:237}%S", the same with milliseconds: "${color:252}%H${color:243}%M${color:237}%S.%.3", red background in case of highlight: "${if:${highlight}?${color:,red}}%H:%M:%S", red background in case of highlight with grayscale: ${if:${highlight}?${color:yellow,124}%H${color:187}%M${color:181}%S.%.3:${color:252}%H${color:243}%M${color:237}%S.%.3}
-
type: string
-
values: any string
-
default value:
"%H:%M:%S"
-
-
-
description: time displayed for a message with same time as previous message: use a space " " to hide time, another string to display this string instead of time, or an empty string to disable feature (display time) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: keep a space on the right side of chat area if there is a bar displayed on the right (for both text and read marker)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
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:
on
-
-
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:
on
-
-
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:
on
-
-
weechat.look.color_nick_offline
-
description: use a different color for offline nicks (not in nicklist anymore)
-
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
-
-
-
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
-
-
-
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.command_incomplete
-
description: if set, incomplete and unambiguous commands are allowed, for example /he for /help
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.look.config_permissions
-
description: permissions for configuration files (*.conf), as octal value (see man chmod); it must be a number with 3 digits, each digit can be 0 (no permissions), 2 (write only), 4 (read only) or 6 (read and write); the first digit must be 6 so that the user can read and write the file; by default configuration files can be read and written by the user only, for security reasons; for example 660 = "rw-rw-r--" = file readable and writable by the user and members of the group
-
type: string
-
values: any string
-
default value:
"600"
-
-
-
description: if set, /quit command must be confirmed with extra argument "-yes" (see /help quit)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: if set, /upgrade command must be confirmed with extra argument "-yes" (see /help upgrade)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: display special message when day changes
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.look.day_change_message_1date
-
description: message displayed when the day has changed, with one date displayed (for example at beginning of buffer) (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
"-- %a, %d %b %Y --"
-
-
weechat.look.day_change_message_2dates
-
description: message displayed when the day has changed, with two dates displayed (between two messages); the second date specifiers must start with two "%" because strftime is called two times on this string (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
"-- %%a, %%d %%b %%Y (%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.emphasized_attributes
-
description: attributes for emphasized text: one or more attribute chars ("%" for blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline); if the string is empty, the colors weechat.color.emphasized* are used
-
type: string
-
values: any string
-
default value:
""
-
-
-
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_disable_regex
-
description: POSIX extended regular expression used to prevent any highlight from a message: this option has higher priority over other highlight options (if the string is found in the message, the highlight is disabled and the other options are ignored), regular expression is case-insensitive (use "(?-i)" at beginning to make it case-sensitive), examples: "
", "(?-i) " -
type: string
-
values: any string
-
default value:
""
-
-
-
description: use a specific color for prefix of line in case of highlight (see also option weechat.look.buffer_time_format)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: POSIX extended regular expression used to check if a message has highlight or not, at least one match in string must be surrounded by delimiters (chars different from: alphanumeric, "-", "_" and "|"), 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:
""
-
-
-
description: comma separated list of tags to highlight; case-insensitive comparison; wildcard "*" is allowed in each tag; many tags can be separated by "+" to make a logical "and" between tags; examples: "nick_flashcode" for messages from nick "FlashCode", "irc_notice+nick_toto*" for notices from a nick starting with "toto"
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.look.hotlist_add_conditions
-
description: conditions to add a buffer in hotlist (if notify level is OK for the buffer); you can use in these conditions: "window" (current window pointer), "buffer" (buffer pointer to add in hotlist), "priority" (0 = low, 1 = message, 2 = private, 3 = highlight); by default a buffer is added to hotlist if you are away, or if the buffer is not visible on screen (not displayed in any window), or if at least one relay client is connected via the weechat protocol
-
type: string
-
values: any string
-
default value:
"${away} || ${buffer.num_displayed} == 0 || ${info:relay_client_count,weechat,connected} > 0"
-
-
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, other number = display max N messages count (from the highest to lowest priority)
-
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 .. 10000
-
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
-
-
-
description: text displayed at the beginning of the hotlist
-
type: string
-
values: any string
-
default value:
"H: "
-
-
-
description: remove buffers in hotlist: buffer = remove buffer by buffer, merged = remove all visible merged buffers at once
-
type: enum
-
values: buffer, merged
-
default value:
merged
-
-
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
-
-
-
description: comma-separated list of fields to sort hotlist; each field is a hdata variable of hotlist ("var") or a hdata variable of buffer ("buffer.var"); char "-" can be used before field to reverse order, char "~" can be used to do a case-insensitive comparison; examples: "-priority,buffer.number" for sort on hotlist priority then by buffer number, "-~buffer.full_name" for case-insensitive and reverse sort on buffer full name
-
type: string
-
values: any string
-
default value:
"-priority,time,time_usec"
-
-
-
description: text displayed at the end of the hotlist
-
type: string
-
values: any string
-
default value:
""
-
-
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.hotlist_update_on_buffer_switch
-
description: update the hotlist when switching buffers
-
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_multiline_lead_linebreak
-
description: start the input text on a new line when the input contains multiple lines, so that the start of the lines align
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: share commands, text, or both in input for all buffers (there is still local history for each buffer)
-
type: enum
-
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
-
-
-
description: max number of "undo" for command line, by buffer (0 = undo disabled)
-
type: integer
-
values: 0 .. 65535
-
default value:
32
-
-
weechat.look.item_away_message
-
description: display server away message in away bar item
-
type: boolean
-
values: on, off
-
default value:
on
-
-
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:
"*"
-
-
-
description: string used to show zoom on merged buffer (bar item "buffer_zoom")
-
type: string
-
values: any string
-
default value:
"!"
-
-
weechat.look.item_mouse_status
-
description: string used to show if mouse is enabled (bar item "mouse_status")
-
type: string
-
values: any string
-
default value:
"M"
-
-
-
description: time format for "time" bar item (see man strftime for date/time specifiers) (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
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.jump_smart_back_to_buffer
-
description: jump back to initial buffer after reaching end of hotlist
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: allow only binding of "safe" keys (beginning with a ctrl or meta code)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: default delay (in milliseconds) to grab a key (using default key alt-k); this delay can be overridden in the /input command (see /help input)
-
type: integer
-
values: 1 .. 10000
-
default value:
800
-
-
-
description: enable mouse support
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
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"); look up for nicks is with exact case then lower case, so it's possible to use only lower case for nicks in this option; color can include background with the format "text,background", for example "yellow,red"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: hash algorithm used to find the color for a nick: djb2 = variant of djb2 (position of letters matters: anagrams of a nick have different color), djb2_32 = variant of djb2 using 32-bit instead of 64-bit integer, sum = sum of letters, sum_32 = sum of letters using 32-bit instead of 64-bit integer
-
type: enum
-
values: djb2, sum, djb2_32, sum_32
-
default value:
djb2
-
-
weechat.look.nick_color_hash_salt
-
description: salt for the hash algorithm used to find nick colors (the nickname is appended to this salt and the hash algorithm operates on this string); modifying this shuffles nick colors
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.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"); this option has an impact on option weechat.look.nick_color_force, so the nick for the forced color must not contain the chars ignored by this option
-
type: string
-
values: any string
-
default value:
"_|["
-
-
-
description: text to display before nick in prefix of message, example: "<"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: text to display after nick in prefix of message, example: ">"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: enable terminal "bracketed paste mode" (not supported in all terminals/multiplexers): in this mode, pasted text is bracketed with control sequences so that WeeChat can differentiate pasted text from typed-in text ("ESC[200~", followed by the pasted text, followed by "ESC[201~")
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.look.paste_bracketed_timer_delay
-
description: force end of bracketed paste after this delay (in seconds) if the control sequence for end of bracketed paste ("ESC[201~") was not received in time
-
type: integer
-
values: 1 .. 60
-
default value:
10
-
-
-
description: max number of lines for paste without asking user (-1 = disable this feature); this option is used only if the bar item "input_paste" is used in at least one bar (by default it is used in "input" bar)
-
type: integer
-
values: -1 .. 2147483647
-
default value:
100
-
-
-
description: prefix for action messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
" *"
-
-
-
description: prefix alignment (none, left, right (default))
-
type: enum
-
values: none, left, right
-
default value:
right
-
-
-
description: max size for prefix (0 = no max size)
-
type: integer
-
values: 0 .. 128
-
default value:
0
-
-
-
description: min size for prefix
-
type: integer
-
values: 0 .. 128
-
default value:
0
-
-
weechat.look.prefix_align_more
-
description: char to display if prefix is truncated (must be exactly one char on screen)
-
type: string
-
values: any string
-
default value:
""+
-
-
weechat.look.prefix_align_more_after
-
description: display the truncature char (by default "+") after the text (by replacing the space that should be displayed here); if disabled, the truncature char replaces last char of text
-
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: enum
-
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: char to display if buffer name is truncated (when many buffers are merged with same number) (must be exactly one char on screen)
-
type: string
-
values: any string
-
default value:
""+
-
-
weechat.look.prefix_buffer_align_more_after
-
description: display the truncature char (by default "+") after the text (by replacing the space that should be displayed here); if disabled, the truncature char replaces last char of text
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: prefix for error messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
"=!="
-
-
-
description: prefix for join messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
"-->"
-
-
-
description: prefix for network messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
"--"
-
-
-
description: prefix for quit messages (note: content is evaluated, so you can use colors with format "${color:xxx}", see /help eval)
-
type: string
-
values: any string
-
default value:
"<--"
-
-
-
description: prefix displayed for a message with same nick as previous but not next message: use a space " " to hide prefix, another string to display this string instead of prefix, or an empty string to disable feature (display prefix)
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.look.prefix_same_nick_middle
-
description: prefix displayed for a message with same nick as previous and next message: use a space " " to hide prefix, another string to display this string instead of prefix, or an empty string to disable feature (display prefix)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: string displayed after prefix
-
type: string
-
values: any string
-
default value:
"│"
-
-
weechat.look.quote_nick_prefix
-
description: text to display before nick when quoting a message (see /help cursor)
-
type: string
-
values: any string
-
default value:
"<"
-
-
weechat.look.quote_nick_suffix
-
description: text to display after nick when quoting a message (see /help cursor)
-
type: string
-
values: any string
-
default value:
">"
-
-
weechat.look.quote_time_format
-
description: time format when quoting a message (see /help cursor) (see man strftime for date/time specifiers, extra specifiers are supported, see function util_strftimeval in Plugin API reference)
-
type: string
-
values: any string
-
default value:
"%H:%M:%S"
-
-
-
description: use a marker (line or char) on buffers to show first unread line
-
type: enum
-
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.read_marker_update_on_buffer_switch
-
description: update the read marker when switching buffers
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.look.save_config_on_exit
-
description: save configuration file on exit
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.look.save_config_with_fsync
-
description: use fsync to synchronize the configuration file with the storage device (see man fsync); this is slower but should prevent any data loss in case of power failure during the save of configuration file
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.look.save_layout_on_exit
-
description: save layout on exit (buffers, windows, or both)
-
type: enum
-
values: none, buffers, windows, all
-
default value:
none
-
-
-
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 and windows (empty value will draw a real line with ncurses, but may cause bugs with URL selection under some terminals); width on screen must be exactly one char
-
type: string
-
values: any string
-
default value:
"-"
-
-
weechat.look.separator_vertical
-
description: char used to draw vertical separators around bars and windows (empty value will draw a real line with ncurses); width on screen must be exactly one char
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: number of spaces used to display tabs in messages
-
type: integer
-
values: 1 .. 64
-
default value:
1
-
-
-
description: time format for dates converted to strings and displayed in messages (see man strftime for date/time specifiers)
-
type: string
-
values: any string
-
default value:
"%a, %d %b %Y %T"
-
-
-
description: automatically zoom on current window if the terminal becomes too small to display all windows (use alt-z to unzoom windows when the terminal is big enough)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
weechat.look.window_separator_horizontal
-
description: display an horizontal separator between windows
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.look.window_separator_vertical
-
description: display a vertical separator between windows
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: title for window (terminal for Curses GUI), set on startup; an empty string will keep title unchanged (note: content is evaluated, see /help eval); example: "WeeChat ${info:version}"
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.look.word_chars_highlight
-
description: comma-separated list of chars (or range of chars) that are considered part of words for highlights; each item can be a single char, a range of chars (format: a-z), a class of wide character (for example "alnum", see man wctype); a "!" before the item makes it negative (ie the char is NOT considered part of words); the value "*" matches any char; unicode chars are allowed with the format \u1234, for example \u00A0 for unbreakable space (see /help print for supported formats)
-
type: string
-
values: any string
-
default value:
"!\u00A0,-,_,|,alnum"
-
-
-
description: comma-separated list of chars (or range of chars) that are considered part of words for command line; each item can be a single char, a range of chars (format: a-z), a class of wide character (for example "alnum", see man wctype); a "!" before the item makes it negative (ie the char is NOT considered part of words); the value "*" matches any char; unicode chars are allowed with the format \u1234, for example \u00A0 for unbreakable space (see /help print for supported formats)
-
type: string
-
values: any string
-
default value:
"!\u00A0,-,_,|,alnum"
-
-
weechat.network.connection_timeout
-
description: timeout (in seconds) for connection to a remote host (made in a child process)
-
type: integer
-
values: 1 .. 2147483647
-
default value:
60
-
-
weechat.network.gnutls_ca_system
-
description: load system's default trusted certificate authorities on startup; this can be turned off to save some memory only if you are not using TLS connections at all
-
type: boolean
-
values: on, off
-
default value:
on
-
-
weechat.network.gnutls_ca_user
-
description: extra file(s) with certificate authorities; multiple files must be separated by colons (each path is evaluated, see function string_eval_path_home in plugin API reference)
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.network.gnutls_handshake_timeout
-
description: timeout (in seconds) for gnutls handshake
-
type: integer
-
values: 1 .. 2147483647
-
default value:
30
-
-
-
description: name of proxy used for download of URLs with Curl (used to download list of scripts and in scripts calling function hook_process); the proxy must be defined with command /proxy
-
type: string
-
values: any string
-
default value:
""
-
-
-
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, wildcard "*" is allowed in names (examples: "*" or "*,!lua,!tcl")
-
type: string
-
values: any string
-
default value:
"*"
-
-
-
description: comma separated list of file name extensions for plugins
-
type: string
-
values: any string
-
default value:
".so,.dll"
-
-
-
description: path for searching plugins (path is evaluated, see function string_eval_path_home in plugin API reference)
-
type: string
-
values: any string
-
default value:
"${weechat_data_dir}/plugins"
-
-
weechat.plugin.save_config_on_unload
-
description: save configuration files when unloading plugins
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: command to execute when the signal is received, multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
"${if:${info:weechat_headless}?/reload:/quit -yes}"
-
-
-
description: command to execute when the signal is received, multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
"/quit -yes"
-
-
-
description: command to execute when the signal is received, multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
"/quit -yes"
-
-
-
description: command to execute when the signal is received, multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: command to execute when the signal is received, multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.startup.command_after_plugins
-
description: command executed when WeeChat starts, after loading plugins; multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
""
-
-
weechat.startup.command_before_plugins
-
description: command executed when WeeChat starts, before loading plugins; multiple commands can be separated by semicolons (note: commands are evaluated, see /help eval)
-
type: string
-
values: any string
-
default value:
""
-
-
-
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
-
-
-
description: set resource limits for WeeChat process, format is: "res1:limit1,res2:limit2"; resource name is the end of constant (RLIMIT_XXX) in lower case (see man setrlimit for values); limit -1 means "unlimited"; example: set unlimited size for core file and max 1GB of virtual memory: "core:-1,as:1000000000"
-
type: string
-
values: any string
-
default value:
""
-
8. IRC
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).
8.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 #weechat-fr on server irc.libera.chat server, default port (6667), with nick alice:
weechat irc://alice@irc.libera.chat/#weechat,#weechat-fr
8.2. Servers
Add a server
By default no servers are defined. You can add as many servers as you want with the /server command.
For example to connect to libera.chat ↗:
/server add libera irc.libera.chat
Note
|
Default port is 6697 and TLS (encrypted traffic) is enabled. |
You can tell WeeChat to auto-connect to this server on startup:
/set irc.server.libera.autoconnect on
To authenticate, it is recommended to use SASL (if supported on the server), with the password stored as secured data (see also chapter on SASL authentication):
/set irc.server.libera.sasl_username "alice" /secure set libera xxxxxxx /set irc.server.libera.sasl_password "${sec.data.libera}"
If SASL is not supported, you can use a command to send a message to nickserv:
/set irc.server.libera.command "/msg nickserv identify ${sec.data.libera}"
Note
|
By sending a message to nickserv, you may authenticate after joining channels
which could be a problem on some channels requiring you to be authenticated
to join. In this case, you can set a command delay:
/set irc.server.libera.command_delay 5 .
|
Server options
Server options are named irc.server.<server>.<option>
where <server>
is the
internal name of the server and <option>
the name of an option.
The value of a server option is inherited from irc.server_default.xxx
if the server option has the special value null
.
For example if you created the libera server with the commands above, you’ll
see this with the command /fset libera
:
irc.server.libera.addresses string "irc.libera.chat" irc.server.libera.anti_flood integer null -> 2000 irc.server.libera.autoconnect boolean on irc.server.libera.autojoin string null -> "" irc.server.libera.autojoin_delay integer null -> 0 irc.server.libera.autojoin_dynamic boolean null -> off irc.server.libera.autoreconnect boolean null -> on irc.server.libera.autoreconnect_delay integer null -> 10 irc.server.libera.autorejoin boolean null -> off irc.server.libera.autorejoin_delay integer null -> 30 irc.server.libera.away_check integer null -> 0 irc.server.libera.away_check_max_nicks integer null -> 25 irc.server.libera.capabilities string null -> "*" irc.server.libera.charset_message enum null -> message irc.server.libera.command string null -> "" irc.server.libera.command_delay integer null -> 0 irc.server.libera.connection_timeout integer null -> 60 irc.server.libera.default_chantypes string null -> "#&" irc.server.libera.ipv6 enum null -> auto irc.server.libera.local_hostname string null -> "" irc.server.libera.msg_kick string null -> "" irc.server.libera.msg_part string null -> "WeeChat ${info:version}" irc.server.libera.msg_quit string null -> "WeeChat ${info:version}" irc.server.libera.nicks string null -> "${username},${username}2,${username}3,${username}4,${username}5" irc.server.libera.nicks_alternate boolean null -> on irc.server.libera.notify string null -> "" irc.server.libera.password string null -> "" irc.server.libera.proxy string null -> "" irc.server.libera.realname string null -> "" irc.server.libera.registered_mode string null -> "r" irc.server.libera.sasl_fail enum null -> reconnect irc.server.libera.sasl_key string null -> "" irc.server.libera.sasl_mechanism enum null -> plain irc.server.libera.sasl_password string "${sec.data.libera}" irc.server.libera.sasl_timeout integer null -> 15 irc.server.libera.sasl_username string "alice" irc.server.libera.split_msg_max_length integer null -> 512 irc.server.libera.tls boolean null -> on irc.server.libera.tls_cert string null -> "" irc.server.libera.tls_dhkey_size integer null -> 2048 irc.server.libera.tls_fingerprint string null -> "" irc.server.libera.tls_password string null -> "" irc.server.libera.tls_priorities string null -> "NORMAL" irc.server.libera.tls_verify boolean null -> on irc.server.libera.usermode string null -> "" irc.server.libera.username string null -> "${username}"
For example if you want to automatically connect to all servers you define without having to do it on each server, you can do:
/set irc.server_default.autoconnect on
And then you can reset the server option so that it uses the default inherited
value, which is now on
instead of the default value off
:
/unset irc.server.libera.autoconnect
TLS certificates
When connecting to IRC server with TLS, WeeChat checks by default that the connection is fully trusted.
Some options are used to control TLS connection:
- weechat.network.gnutls_ca_system
-
load system’s default trusted certificate authorities on startup
- weechat.network.gnutls_ca_user
-
extra file(s) with certificate authorities
- irc.server.xxx.tls_cert
-
TLS certificate file used to automatically identify your nick (for example CertFP on oftc, see below)
- irc.server.xxx.tls_dhkey_size
-
size of the key used during the Diffie-Hellman Key Exchange (by default: 2048)
- irc.server.xxx.tls_verify
-
check that the TLS connection is fully trusted (on by default)
Note
|
Option "tls_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 -p ~/.config/weechat/tls
wget -O ~/.config/weechat/tls/CAs.pem https://www.spi-inc.org/ca/spi-cacert.crt
Note
|
You must replace ~/.config/weechat by the path to your WeeChat config directory
which can also be for example ~/.weechat .
|
Note
|
It is possible to concatenate many certificates in file CAs.pem. |
-
In WeeChat, with "oftc" server already added:
/connect oftc
Second example: connect to oftc using CertFP
-
Create certificate in shell:
mkdir -p ~/.config/weechat/tls
cd ~/.config/weechat/tls
openssl req -nodes -newkey rsa:2048 -keyout nick.pem -x509 -days 365 -out nick.pem
Note
|
You must replace ~/.config/weechat by the path to your WeeChat config directory
which can also be for example ~/.weechat .
|
-
In WeeChat, with "oftc" server already added:
/set irc.server.oftc.tls_cert "${weechat_config_dir}/tls/nick.pem" /connect oftc /msg nickserv cert add
For more information, please look at this page ↗.
SASL authentication
WeeChat supports SASL authentication, using different mechanisms:
-
plain: plain text password (default)
-
scram-sha-1: SCRAM with SHA-1 digest algorithm
-
scram-sha-256: SCRAM with SHA-256 digest algorithm
-
scram-sha-512: SCRAM with SHA-512 digest algorithm
-
ecdsa-nist256p-challenge: challenge with public/private key
-
external: client side TLS cert
Options in servers are:
-
sasl_mechanism: mechanism to use (see above)
-
sasl_timeout: timeout (in seconds) for authentication
-
sasl_fail: action to perform if authentication fails
-
sasl_username: username (nick)
-
sasl_password: password
-
sasl_key: file with ECC private key (for mechanism ecdsa-nist256p-challenge)
SASL ECDSA-NIST256P-CHALLENGE
You must generate a private key in order to authenticate with the ECDSA-NIST256P-CHALLENGE mechanism (no password is required on connection).
You can generate the key with this command:
openssl ecparam -genkey -name prime256v1 -out ~/.config/weechat/ecdsa.pem
Note
|
You must replace ~/.config/weechat by the path to your WeeChat config directory
which can also be for example ~/.weechat .
|
Get the public key (encoded as base64) with this command:
openssl ec -noout -text -conv_form compressed -in ~/.config/weechat/ecdsa.pem | grep '^pub:' -A 3 | tail -n 3 | tr -d ' \n:' | xxd -r -p | base64
Connect to the server, identify (for example with "nickserv identify") and set your public key in your account, using nickserv (replace the base64 value with your public key):
/connect libera /msg nickserv identify your_password /msg nickserv set pubkey Av8k1FOGetUDq7sPMBfufSIZ5c2I/QYWgiwHtNXkVe/q
Configure the SASL options in the server:
/set irc.server.libera.sasl_mechanism ecdsa-nist256p-challenge /set irc.server.libera.sasl_username "your_nickname" /set irc.server.libera.sasl_key "${weechat_config_dir}/ecdsa.pem"
Reconnect to the server:
/reconnect libera
Connection
You can connect to server with the /connect command:
/connect libera
To disconnect:
/disconnect libera
Or just this if you are on any buffer belonging to libera server (server, channel, private):
/disconnect
When you connect to multiple servers at same time, server buffers are merged
by default and you can switch between them with the Ctrl+x key.
It is possible to disable auto merge of server buffers to have independent
server buffers:
/set irc.look.server_buffer independent
Connect with Tor and SASL
Some servers support connections with Tor ↗, a network of virtual tunnels that allows people and groups to improve their privacy and security on the Internet.
In first place, install Tor. For Debian (and derived):
sudo apt-get install tor
In WeeChat you need to add 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, add a new server (replace server name "irc-tor" and the address by a valid one):
/server add irc-tor this.is.the.address.onion
Set proxy for Tor:
/set irc.server.irc-tor.proxy "tor"
Set SASL authentication with ECDSA-NIST256P-CHALLENGE (see the chapter SASL ECDSA-NIST256P-CHALLENGE to generate a private key):
/set irc.server.irc-tor.sasl_mechanism ecdsa-nist256p-challenge /set irc.server.irc-tor.sasl_username "your_nickname" /set irc.server.irc-tor.sasl_key "${weechat_config_dir}/ecdsa.pem"
And finally, connect to the server:
/connect irc-tor
8.3. IRCv3 support
WeeChat supports the following IRCv3 extensions ↗:
By default all capabilities supported by the server and WeeChat are automatically enabled (see option irc.server_default.capabilities).
Tables with comparison of different IRC clients, including WeeChat, are available on this page ↗.
account-notify
Specification: account-notify ↗
This capability allows the server to send messages when users identify or
unidentify on the server.
WeeChat displays such messages if the option
irc.look.display_account_message
is enabled (default value).
Examples:
-- alice has identified as Alice01 -- alice has unidentified
account-tag
Specification: account-tag ↗
This capability allows the server to send account as message tag to commands
sent to the client.
WeeChat parses this tag and saves it in the message, but it is not used or
displayed. It can be used in /filter command to filter
messages matching specific accounts.
Example of raw IRC message received:
@account=Alice01 :user@example.com PRIVMSG #test :Hello!
Message displayed in channel:
<alice> Hello!
Message with tags:
<alice> Hello! [irc_privmsg,irc_tag_account_Alice01,notify_message,prefix_nick_lightcyan,nick_alice,host_user@example.com,log1]
away-notify
Specification: away-notify ↗
This capability allows the server to send away notifications for users present on the same channels as you.
When the away status is changed for a user (away or back), this is reflected with a specific color in the nicklist, using the following options:
batch
Specification: batch ↗
This capability allows the server to send batched events (grouping of several messages that are related).
For now, WeeChat only stores messages received in a batch and processes as usual later, when the batch ends.
cap-notify
Specification: cap-notify ↗
This capability allows the server to advertise on new or removed capabilities
on the server (via CAP NEW
and CAP DEL
commands).
Examples:
-- irc: client capability, now available: sasl -- irc: client capability, removed: sasl
chghost
Specification: chghost ↗
This capability allows the server to send messages when users change name or host.
When the option irc.look.smart_filter_chghost
is enabled (default value), the host changes are automatically hidden if the nick
has not spoken for several minutes.
The color of the change host message is controlled by the option
irc.color.message_chghost.
Example:
-- alice (user@example.com) has changed host to test.com
draft/multiline
Specification: multiline ↗
This capability allows the client and server to send messages with multiple lines, using the batch capability, that must be enabled as well.
There are limits in term of bytes or number of lines in a multiline message that are given in the capability sent by the server, for example:
CAP alice LS * :draft/multiline=max-bytes=4096,max-lines=24
This sets a limit of 4096 bytes and 24 lines for a multiline batched content.
If the limits are not given by the server, the default in WeeChat are:
-
max bytes: 4096
-
max lines: 24
Only standard messages and those send by the /notice
command can be multiline.
ACTION CTCP messages sent with command /me are not affected
by this capability. That means multiline actions are sent as multiple actions.
Warning
|
As the specification is a "draft", it may change and the multiline support can
possibly break at any time in WeeChat. The capability is automatically enabled if the server supports it and can be disabled with this command: /set irc.server_default.capabilities "*,!draft/multiline" .When the capability is disabled, a multiline message is sent as multiple messages, as if they were sent sequentially to the server. |
Example of IRC messages sent for a user message with two lines (this is a test
/ on two lines
), send to channel #test:
BATCH +i8Je7M7gquddoyC9 draft/multiline #test @batch=i8Je7M7gquddoyC9 PRIVMSG #test :this is a test @batch=i8Je7M7gquddoyC9 PRIVMSG #test :on two lines BATCH -i8Je7M7gquddoyC9
Display of the message sent in WeeChat:
19:01:45 alice | this is a test | on two lines
echo-message
Specification: echo-message ↗
This capability forces the server to send PRIVMSG, NOTICE and TAGMSG messages back to WeeChat.
WeeChat displays only the message received and not the message sent, so a delay can be noticed between the send and the display. When the message is displayed, it means it has been properly received by the server and propagated to other clients connected to the server as well.
extended-join
Specification: extended-join ↗
This capability allows the server to send account and real name when users
join channels.
WeeChat displays this additional information in join messages if the option
irc.look.display_extended_join
is enabled (default value).
Example:
--> john [John01] (John Doe) (~user@example.com) has joined #test
invite-notify
Specification: invite-notify ↗
This capability allows the server to send invite messages when users are invited to channels.
Example:
-- alice has invited bob to #test
message-tags
Specification: message-tags ↗
This capability allows to add metadata in messages.
These tags can be displayed using the command /debug tags
.
It must be enabled to use typing notifications.
monitor
Specification: monitor ↗
This capability allows the server to send notifications when clients become
online/offline.
WeeChat automatically uses this extension if available when using the
/notify command.
multi-prefix
Specification: multi-prefix ↗
Note
|
For now, WeeChat doesn’t display all prefixes in the /names output, even if
they are received and properly saved internally.
|
Example: output of /whois alice
:
-- [alice] @%+#test
server-time
Specification: server-time ↗
This capability allows the server to send time for messages as message tag.
When the time is received in a message, WeeChat uses it to display the message
(it can then be displayed with a past date).
The IRC proxy in Relay plugin supports this capability, so any IRC client of Relay should enable it to display the real message time in the backlog sent upon connection.
setname
Specification: setname ↗
This capability lets you change your real name by using the /setname command.
userhost-in-names
Specification: userhost-in-names ↗
This capability allows the server to send hostnames in /names responses.
Note
|
WeeChat doesn’t display hostnames in the /names output.
|
Example of raw IRC messages received without the capability:
:irc.server 353 alice = #test :@alice bob +carol
Example of raw IRC messages received with the capability:
:irc.server 353 alice = #test :@alice!user1@host1 bob!user2@host2 +carol!user3@host3
8.4. Channels
You can join channels with the /join command:
/join #channel
Part a channel (keeping the buffer open):
/part [quit message]
The channels you joined are not saved. If you want to join them automatically
when connecting to the server, you must set the server autojoin
option:
/set irc.server.libera.autojoin "#weechat,#weechat-fr"
Note
|
Some scripts can help to automatically set this option,
see /script search autojoin .
|
Be careful, spaces can be used only to separate list of channels from keys,
for example if #channel1
requires a key but not #channel2
:
/set irc.server.libera.autojoin "#channel1,#channel2 key1"
For help on the format, see option irc.server_default.autojoin.
8.5. Private messages
You can send a private message with the /query command, which opens a separate buffer:
/query bob hi, how are you?
Without arguments the command just opens the buffer (or selects it if already open):
/query bob
To close the private buffer, you can do this command on the private buffer:
/close
8.6. Smart filter
A smart filter is available to filter some messages when someone did not write anything in the channel during a configurable delay:
-
join: user joins the channel
-
part: user leaves the channel
-
quit: user quits the server
-
account: user changes its account
-
chghost: user changes name or host
-
mode: mode changes on channel
-
nick: user changes its nick
-
setname: user changes its real name
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 the /filter command):
/filter add irc_smart_weechat irc.libera.#weechat* irc_smart_filter *
You can setup a longer delay (in minutes):
/set irc.look.smart_filter_delay 10
If someone did not write anything during last 10 minutes, its messages like join/part/quit will be hidden by default on channel, and you can use key Alt+= (toggle filters) to see them.
8.7. 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!"
Note
|
The name of CTCP must be in lower case. That means option irc.ctcp.VERSION would not work. |
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.libera.version "WeeChat ${version} (for libera)"
If you want to restore standard CTCP reply, then remove option:
/unset irc.ctcp.version
The CTCP replies are evaluated (see command /eval) and the following extra variables are available:
Variable | Description | Value/example |
---|---|---|
|
List of supported CTCP |
|
|
WeeChat version |
|
|
WeeChat version + Git version (1) |
|
|
Git version (1) |
|
|
WeeChat compilation date |
|
|
Info about OS |
|
|
WeeChat site |
|
|
WeeChat site, download page |
|
|
Current date/time |
|
|
User name on IRC server |
|
|
Real name on IRC server |
|
Note
|
(1) The Git version is the output of command git describe . It is known only
if WeeChat has been compiled inside the Git repository and if Git was installed.
|
The default CTCP replies are:
CTCP | Reply format | Example |
---|---|---|
CLIENTINFO |
|
|
SOURCE |
|
|
TIME |
|
|
VERSION |
|
|
8.8. 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 |
|
|
invited on a channel |
|
|
join |
|
|
kick |
|
|
kill |
|
|
mode |
|
|
notice |
|
|
part |
|
|
quit |
|
|
topic |
|
|
wallops |
|
|
ctcp (sent or received, in a privmsg or notice message) |
|
|
user mode string |
|
|
|
whois (secure connection) |
|
|
whois (away) |
|
ison |
|
|
|
unaway |
|
|
away |
|
|
whois (registered nick) |
|
|
whois (help mode) |
|
|
whois (user) |
|
|
whois (server) |
|
|
whois (operator) |
|
|
whowas |
|
|
who (end) |
|
|
whois (idle) |
|
|
whois (end) |
|
|
whois (channels) |
|
|
whois (identified user) |
|
|
list (start) |
|
|
list (channel) |
|
|
list (end) |
|
|
whois (has oper privs) |
|
|
whois (host) |
|
channel URL |
|
|
channel creation date |
|
|
|
whois (logged in as) |
|
no topic for channel |
|
|
topic of channel |
|
|
infos about topic |
|
|
|
whois (is a bot on) |
|
|
whois (host) |
|
inviting |
|
|
|
whois (is opered as) |
|
|
channel reop |
|
|
channel reop (end) |
|
|
invite list |
|
|
invite list (end) |
|
|
exception list |
|
|
exception list (end) |
|
server version |
|
|
|
who |
|
|
list of users on channel |
|
|
end of /names list |
|
|
ban list |
|
|
end of ban list |
|
|
whowas (end) |
|
|
whois (connecting from) |
|
|
whois (using modes) |
|
|
no such nick/channel |
|
|
no such server |
|
erroneous nickname |
|
|
nickname already in use |
|
|
not authorized to change nickname |
|
|
|
whois (secure connection) |
|
|
quiet list |
|
|
end of quiet list |
|
|
list of monitored nicks |
|
|
list of monitored nicks (end) |
|
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: libera.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 "libera" server:
/set irc.msgbuffer.libera.invite current
-
Display message "303" (ison) on WeeChat "core" buffer:
/set irc.msgbuffer.303 weechat
8.9. Commands
-
action
: send a CTCP action to a nick or channel
/action [-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
-
admin
: find information about the administrator of the server
/admin [<target>] target: server name
-
allchan
: execute a command on all channels of all connected servers
/allchan [-current] [-parted|-all] [-exclude=<channel>[,<channel>...]] <command> [-current] [-parted|-all] -include=<channel>[,<channel>...] <command> -current: execute command for channels of current server only -parted: execute command on parted channels (by default: execute command on active channels only) -all: execute command on all channels (active and parted) -exclude: exclude some channels (wildcard "*" is allowed) -include: include only some channels (wildcard "*" is allowed) command: command to execute (or text to send to buffer if command does not start with "/") Command and arguments are evaluated (see /help eval), the following variables are replaced: $server: server name $channel: channel name $nick: nick on server ${irc_server.xxx}: variable xxx in server ${irc_channel.xxx}: variable xxx in channel Examples: execute "/me is testing" on all channels: /allchan /me is testing say "hello" everywhere but not on #weechat: /allchan -exclude=#weechat hello say "hello" everywhere but not on #weechat and channels beginning with #linux: /allchan -exclude=#weechat,#linux* hello say "hello" on all channels beginning with #linux: /allchan -include=#linux* hello close all buffers with parted channels: /allchan -parted /close
-
allpv
: execute a command on all private buffers of all connected servers
/allpv [-current] [-exclude=<nick>[,<nick>...]] <command> [-current] -include=<nick>[,<nick>...] <command> -current: execute command for private buffers of current server only -exclude: exclude some nicks (wildcard "*" is allowed) -include: include only some nicks (wildcard "*" is allowed) command: command to execute (or text to send to buffer if command does not start with "/") Command and arguments are evaluated (see /help eval), the following variables are replaced: $server: server name $channel: channel name $nick: nick on server ${irc_server.xxx}: variable xxx in server ${irc_channel.xxx}: variable xxx in channel Examples: execute "/me is testing" on all private buffers: /allpv /me is testing say "hello" everywhere but not for nick foo: /allpv -exclude=foo hello say "hello" everywhere but not for nick foo and nicks beginning with bar: /allpv -exclude=foo,bar* hello say "hello" for all nicks beginning with bar: /allpv -include=bar* hello close all private buffers: /allpv /close
-
allserv
: execute a command on all connected servers
/allserv [-exclude=<server>[,<server>...]] <command> -include=<server>[,<server>...] <command> -exclude: exclude some servers (wildcard "*" is allowed) -include: include only some servers (wildcard "*" is allowed) command: command to execute (or text to send to buffer if command does not start with "/") Command and arguments are evaluated (see /help eval), the following variables are replaced: $server: server name $nick: nick on server ${irc_server.xxx}: variable xxx in server Examples: change nick on all servers: /allserv /nick newnick do a whois on my nick on all servers: /allserv /whois $nick
-
auth
: authenticate with SASL
/auth [<username> <password>] username: SASL username (content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name) password: SASL password or path to file with private key (content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name) If username and password are not provided, the values from server options "sasl_username" and "sasl_password" (or "sasl_key") are used. Examples: authenticate with username/password defined in the server: /auth authenticate as a different user: /auth user2 password2 authenticate as a different user with mechanism ecdsa-nist256p-challenge: /auth user2 ${weechat_config_dir}/ecdsa2.pem
-
autojoin
: configure the "autojoin" server option
/autojoin add [<channel>...] addraw <channel1>[,<channel2>...] [<key1>[,<key2>...]] del [<channel>...] apply join sort [buffer] add: add current channel or a list of channels (with optional keys) to the autojoin option; if you are on the channel and the key is not provided, the key is read in the channel addraw: use the IRC raw format (same as /join command): all channels separated by commas, optional keys separated by commas del: delete current channel or a list of channels from the autojoin option channel: channel name key: key for the channel apply: set currently joined channels in the autojoin option join: join the channels in the autojoin option sort: sort alphabetically channels in the autojoin option; with "buffer": first sort by buffer number, then alphabetically Examples: /autojoin add /autojoin add #test /autojoin add #chan1 #chan2 /allchan /autojoin add /autojoin addraw #chan1,#chan2,#chan3 key1,key2 /autojoin del /autojoin del #chan1 /autojoin apply /autojoin join /autojoin sort /autojoin sort buffer
-
ban
: ban nicks or hosts
/ban [<channel>] [<nick>...] channel: channel name nick: nick or host Without argument, this command displays the ban list for current channel.
-
cap
: client capability negotiation
/cap ls list req|ack [<capability>...] end ls: list the capabilities supported by the server list: list the capabilities currently enabled req: request a new capability or remove a capability (if starting with "-", for example: "-multi-prefix") ack: acknowledge capabilities which require client-side acknowledgement end: end the capability negotiation Without argument, "ls" and "list" are sent. Capabilities supported by WeeChat are: account-notify, account-tag, away-notify, batch, cap-notify, chghost, draft/multiline, echo-message, extended-join, invite-notify, message-tags, multi-prefix, server-time, setname, userhost-in-names. The capabilities to automatically enable on servers can be set in option irc.server_default.capabilities (or by server in option irc.server.xxx.capabilities). Examples: display supported and enabled capabilities: /cap request capabilities multi-prefix and away-notify: /cap req multi-prefix away-notify request capability extended-join, remove capability multi-prefix: /cap req extended-join -multi-prefix remove capability away-notify: /cap req -away-notify
-
connect
: connect to IRC server(s)
/connect [<server>...] [-<option>[=<value>]] [-no<option>] [-nojoin] [-switch] -all|-auto|-open [-nojoin] [-switch] server: server name, which can be: - internal server name (added by /server add, recommended usage) - hostname/port or IP/port, port is 6697 by default for TLS, 6667 otherwise - URL with format: irc[6][s]://[nickname[:password]@]irc.example.org[:port][/#channel1][,#channel2[...]] Note: for an address/IP/URL, a temporary server is added (NOT SAVED), see /help irc.look.temporary_servers option: set option for server (for boolean option, value can be omitted) nooption: set boolean option to "off" (for example: -notls) -all: connect to all servers defined in configuration -auto: connect to servers with autoconnect enabled -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 To disconnect from a server or stop any connection attempt, use command /disconnect. Examples: /connect libera /connect irc.oftc.net /connect irc.oftc.net/6667 -notls /connect irc6.oftc.net/9999 -ipv6=force /connect my.server.org -password=test /connect irc://nick@irc.oftc.net/#channel /connect -switch
-
ctcp
: send a CTCP message (Client-To-Client Protocol)
/ctcp [-server <server>] <target>[,<target>...] <type> [<arguments>] server: send to this server (internal name) target: nick or channel ("*" = current channel) type: CTCP type (examples: "version", "ping", etc.) arguments: arguments for CTCP Examples: /ctcp toto time /ctcp toto version /ctcp * version
-
cycle
: leave and rejoin a channel
/cycle [<channel>[,<channel>...]] [<message>] channel: channel name message: part message (displayed to other users)
-
dcc
: start a DCC (passive file transfer or direct chat)
/dcc chat <nick> send <nick> <file> nick: nick file: filename (on local host) Examples: /dcc chat toto /dcc send toto /home/foo/bar.txt
-
dehalfop
: remove channel half-operator status from nick(s)
/dehalfop <nick>... * -yes nick: nick or mask (wildcard "*" is allowed) *: remove channel half-operator status from everybody on channel except yourself
-
deop
: remove channel operator status from nick(s)
/deop <nick>... * -yes nick: nick or mask (wildcard "*" is allowed) *: remove channel operator status from everybody on channel except yourself
-
devoice
: remove voice from nick(s)
/devoice <nick>... * -yes nick: nick or mask (wildcard "*" is allowed) *: remove voice from everybody on channel
-
die
: shutdown the server
/die [<target>] target: server name
-
disconnect
: disconnect from one or all IRC servers
/disconnect [<server>|-all|-pending [<reason>]] server: internal server name -all: disconnect from all servers -pending: cancel auto-reconnection on servers currently reconnecting reason: reason for the "quit"
-
halfop
: give channel half-operator status to nick(s)
/halfop <nick>... * -yes nick: nick or mask (wildcard "*" is allowed) *: give channel half-operator status to everybody on channel
-
ignore
: ignore nicks/hosts from servers or channels
/ignore list add|addreplace [re:]<nick> [<server> [<channel>]] del <number>|-all list: list all ignores add: add an ignore addreplace: add or replace an existing ignore nick: nick or hostname; can be a POSIX extended regular expression if "re:" is given or a mask using "*" to replace zero or more chars (the regular expression can start with "(?-i)" to become case-sensitive) 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: if option irc.look.ignore_tag_messages is enabled, the ignored messages are just tagged with "irc_ignored" instead of being completely removed. Examples: /ignore add toto /ignore add toto@domain.com libera /ignore add toto*@*.domain.com libera #weechat
-
info
: get information describing the server
/info [<target>] target: server name
-
invite
: invite a nick on a channel
/invite <nick>... [<channel>] nick: nick channel: channel name
-
ison
: check if a nick is currently on IRC
/ison <nick>... nick: nick
-
join
: join a channel
/join [-noswitch] [-server <server>] [<channel1>[,<channel2>...]] [<key1>[,<key2>...]] -noswitch: do not switch to new buffer server: send to this server (internal name) channel: channel name 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 libera #weechat /join -noswitch #weechat
-
kick
: kick a user out of a channel
/kick [<channel>] <nick> [<reason>] channel: channel name nick: nick reason: reason (evaluated, see /help eval; special variables ${nick} (self nick), ${target} (target nick), ${channel} and ${server} are replaced by their values)
-
kickban
: kick a user out of a channel and ban the host
/kickban [<channel>] <nick> [<reason>] channel: channel name nick: nick reason: reason (evaluated, see /help eval; special variables ${nick} (self nick), ${target} (target nick), ${channel} and ${server} are replaced by their values) It is possible to kick/ban with a mask, nick will be extracted from mask and replaced by "*". Example: /kickban toto!*@host.com
-
kill
: close client-server connection
/kill <nick> [<reason>] nick: nick reason: reason
-
knock
: send a notice to an invitation-only channel, requesting an invite
/knock <channel> [<message>] channel: channel name message: message to send
-
links
: list all server names which are known by the server answering the query
/links [[<target>] <server_mask>] target: this remote server should answer the query server_mask: list of servers must match this mask
-
list
: list channels and their topics
/list [-server <server>] [<channel>[,<channel>...]] [<target>] [-server <server>] [-raw *|<regex>] -up|-down [<number>] -left|-right [<percent>] -go <line>|end -join -export <filename> server: send to this server (internal name) channel: channel name target: server name -raw: display result on server buffer instead of a dedicated buffer regex: POSIX extended regular expression used to filter results (case-insensitive, can start by "(?-i)" to become case-sensitive); the special value "*" doesn't filter results -up: move the selected line up by "number" lines -down: move the selected line down by "number" lines -left: scroll the buffer by "percent" of width on the left -right: scroll the buffer by "percent" of width on the right -go: select a line by number, first line number is 0 ("end" to select the last line) -join: join the channel on the selected line -export: export list of channels to a file For keys, input and mouse actions on the buffer, see key bindings in User's guide. Sort keys on /list buffer: name: channel name (eg: "##test") name2: channel name without prefix (eg: "test") users: number of users on channel topic: channel topic Examples: list all channels on server buffer (no dedicated buffer and can be slow on large networks): /list -raw * list all channels beginning with "#weechat" on server buffer (no dedicated buffer and can be slow on large networks): /list -raw #weechat.* list all channels on a dedicated buffer (can be slow on large networks): /list list channel #weechat on a dedicated buffer: /list #weechat on /list buffer: channels with "weechat" in name: n:weechat channels with at least 100 users: u:100 channels with "freebsd" (case-insensitive) in topic and more than 10 users: c:${topic} =- freebsd && ${users} > 10 sort channels by users (big channels first), then name2 (name without prefix): s:-users,name2
-
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: channel name to modify (default is current one) Channel modes: o: give/take channel operator privileges p: private channel s: secret channel i: invite-only channel t: topic settable by channel operator only 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: invisible s: user receives server notices w: user receives wallops o: operator List of modes is not comprehensive, you should read documentation about your server to see all possible modes. Examples: /mode #weechat +t /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 [-count | -x] [<channel>[,<channel>...]] -count: display only number of users -x: display only users with this mode: -o for ops, -h for halfops, -v for voiced, etc. and -* for regular users 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 name text: text to send
-
notify
: add a notification for presence or away status of nicks on servers
/notify add|addreplace <nick> [<server> [-away]] del <nick>|-all [<server>] add: add a notification addreplace: add or replace 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 add toto /notify add toto libera /notify add toto libera -away
-
op
: give channel operator status to nick(s)
/op <nick>... * -yes nick: nick or mask (wildcard "*" is allowed) *: give channel operator status to everybody on channel
-
oper
: get operator privileges
/oper <user> <password> user: user password: password
-
part
: leave a channel
/part [<channel>[,<channel>...]] [<message>] channel: channel name message: part message (displayed to other users)
-
ping
: send a ping to server
/ping <target1> [<target2>] target1: server target2: 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 [-noswitch] [-server <server>] <nick>[,<nick>...] [<text>] -noswitch: do not switch to new buffer server: send to this server (internal name) nick: nick text: text to send
-
quiet
: quiet nicks or hosts
/quiet [<channel>] [<nick>...] channel: channel name nick: nick or host Without argument, this command displays the quiet list for current channel.
-
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>... [-nojoin] [-switch] -all [-nojoin] [-switch] server: internal server name -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
-
remove
: force a user to leave a channel
/remove [<channel>] <nick> [<reason>] channel: channel name nick: nick reason: reason (special variables $nick, $channel and $server are replaced by their values)
-
restart
: tell the server to restart itself
/restart [<target>] target: server name
-
rules
: request the server rules
-
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 [<name>] add|addreplace <name> <hostname>[/<port>] [-temp] [-<option>[=<value>]] [-no<option>] copy|rename <name> <new_name> reorder <name>... open <name>|-all [<name>...] del|keep <name> deloutq|jump raw [<filter>] list: list servers (without argument, this list is displayed) listfull: list servers with detailed info for each server add: add a new server addreplace: add or replace an existing server name: server name, for internal and display use; this name is used to connect to the server (/connect name) and to set server options: irc.server.name.xxx hostname: name or IP address of server, with optional port (default: 6697 for TLS, 6667 otherwise), many addresses can be separated by a comma -temp: add a temporary server (not saved) option: set option for server (for boolean option, value can be omitted) nooption: set boolean option to "off" (for example: -notls) copy: duplicate a server rename: rename a server reorder: reorder list of servers open: open the server buffer without connecting 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 filter: set a new filter to see only matching messages (this filter can be used as input in raw IRC data buffer as well); allowed formats are: `*`: show all messages (no filter) `xxx`: show only messages containing "xxx" `s:xxx`: show only messages for server "xxx" `f:xxx`: show only messages with a flag: recv (message received), sent (message sent), modified (message modified by a modifier), redirected (message redirected) `m:xxx`: show only IRC command "xxx" `c:xxx`: show only messages matching the evaluated condition "xxx", using following variables: output of function irc_message_parse (like nick, command, channel, text, etc., see function info_get_hashtable in plugin API reference for the list of all variables), date (format: "%FT%T.%f", see function util_strftimeval in Plugin API reference), server, recv, sent, modified, redirected Examples: /server listfull /server add libera irc.libera.chat /server add libera irc.libera.chat/6667 -notls -autoconnect /server add chatspike irc.chatspike.net/6667,irc.duckspike.net/6667 -notls /server copy libera libera-test /server rename libera-test libera2 /server reorder libera2 libera /server del libera /server deloutq /server raw /server raw s:libera /server raw c:${recv} && ${command}==PRIVMSG && ${nick}==foo
-
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
-
setname
: set real name
/setname <realname> realname: new real name
-
squery
: deliver a message to a service
/squery <service> <text> service: name of service text: text to send
-
squit
: disconnect server links
/squit <target> <comment> target: server name comment: comment
-
stats
: query statistics about server
/stats [<query> [<target>]] query: c/h/i/k/l/m/o/y/u (see RFC1459) target: 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 -delete: delete channel topic
-
trace
: find the route to specific server
/trace [<target>] target: server name
-
unban
: unban nicks or hosts
/unban [<channel>] <nick>|<number>|<n1>-<n2>... channel: channel name nick: nick or host number: ban number (as displayed by command /ban) n1: interval start number n2: interval end number
-
unquiet
: unquiet nicks or hosts
/unquiet [<channel>] <nick>|<number>|<n1>-<n2>... channel: channel name nick: nick or host number: quiet number (as displayed by command /quiet) n1: interval start number n2: interval end number
-
userhost
: return a list of information about nicks
/userhost <nick>... nick: nick
-
users
: list of users logged into the server
/users [<target>] target: server name
-
version
: give the version info of nick or server (current or specified)
/version [<target>|<nick>] target: server name nick: nick
-
voice
: give voice to nick(s)
/voice <nick>... * -yes nick: nick or mask (wildcard "*" is allowed) *: give voice to everybody on channel
-
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 [<target>] [<nick>[,<nick>...]] target: server name nick: nick (may be a mask) Without argument, this command will do a whois on: - your own nick if buffer is a server/channel - remote nick if buffer is a private. If option irc.network.whois_double_nick is enabled, two nicks are sent (if only one nick is given), to get idle time in answer.
-
whowas
: ask for information about a nick which no longer exists
/whowas <nick>[,<nick>...] [<count> [<target>]] nick: nick count: number of replies to return (full search if negative number) target: reply should match this mask
8.10. Options
Sections in file irc.conf:
Section | Control command | Description |
---|---|---|
|
|
Look and feel. |
|
|
Colors. |
|
|
Network options. |
|
|
Target buffer for IRC messages (options can be added/removed in section). |
|
|
CTCP replies (options can be added/removed in section). |
|
Ignore people. |
|
|
|
Default values for servers (used when options in server are not defined). |
|
|
Servers. |
Options:
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightcyan
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
description: color for nick modes in bar item "input_prompt"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
irc.color.item_tls_version_deprecated
-
description: color for deprecated TLS versions in bar item "tls_version"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
irc.color.item_tls_version_insecure
-
description: color for insecure TLS versions in bar item "tls_version"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
red
-
-
-
description: color for higher supported TLS version in bar item "tls_version"
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
irc.color.list_buffer_line_selected
-
description: color for selected line on /list 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
irc.color.list_buffer_line_selected_bg
-
description: background color for selected line on /list 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
24
-
-
-
description: color for text in account 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
cyan
-
-
-
description: color for text in "chghost" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
-
description: color for text in kick/kill 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
red
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
red
-
-
-
description: color for text in "setname" 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
brown
-
-
-
description: remap mirc colors in messages using a hashtable (used only for standard colors, not RGB colors): 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 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=darkgray, 15=gray
-
type: string
-
values: any string
-
default value:
"1,-1:darkgray"
-
-
-
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:
"y:lightred;q:lightred;a:lightcyan;o:lightgreen;h:lightmagenta;v:yellow;*:lightblue"
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
green
-
-
-
description: color for reason in kick/kill 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
244
-
-
-
description: remap terminal color numbers in messages using a hashtable (used only for RGB colors as hexadecimal, which are first translated to terminal color numbers): keys are "fg,bg" as integers between -1 (not specified) and 255, values are WeeChat color names or numbers (format is: "1,-1:color1;2,7:color2"), example: "0,-1:darkgray;0,90:white,blue" to remap black to "darkgray" and black on dark magenta to "white,blue"
-
type: string
-
values: any string
-
default value:
"0,-1:darkgray"
-
-
-
description: color for current channel topic (when joining a channel or using /topic)
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
36
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
244
-
-
-
description: format de réponse CTCP ou une chaîne vide pour bloquer le CTCP (pas de réponse) ; le contenu est évalué, voir /help eval ; les variables suivantes sont remplacées : ${clientinfo} : liste des CTCP supportés, ${version} : version de WeeChat, ${git} : version Git, ${versiongit} : version de WeeChat et version Git, ${compilation} : date de compilation, ${osinfo} : information sur l'OS, ${site} : site de WeeChat, ${download} : page de téléchargement du site de WeeChat, ${time} : date et heure courante sous forme de texte, ${username} : nom d'utilisateur sur le serveur, ${realname} : nom réel sur le serveur
-
type: string
-
values: any string
-
default value:
"${clientinfo}"
-
-
-
description: format de réponse CTCP ou une chaîne vide pour bloquer le CTCP (pas de réponse) ; le contenu est évalué, voir /help eval ; les variables suivantes sont remplacées : ${clientinfo} : liste des CTCP supportés, ${version} : version de WeeChat, ${git} : version Git, ${versiongit} : version de WeeChat et version Git, ${compilation} : date de compilation, ${osinfo} : information sur l'OS, ${site} : site de WeeChat, ${download} : page de téléchargement du site de WeeChat, ${time} : date et heure courante sous forme de texte, ${username} : nom d'utilisateur sur le serveur, ${realname} : nom réel sur le serveur
-
type: string
-
values: any string
-
default value:
"${download}"
-
-
-
description: format de réponse CTCP ou une chaîne vide pour bloquer le CTCP (pas de réponse) ; le contenu est évalué, voir /help eval ; les variables suivantes sont remplacées : ${clientinfo} : liste des CTCP supportés, ${version} : version de WeeChat, ${git} : version Git, ${versiongit} : version de WeeChat et version Git, ${compilation} : date de compilation, ${osinfo} : information sur l'OS, ${site} : site de WeeChat, ${download} : page de téléchargement du site de WeeChat, ${time} : date et heure courante sous forme de texte, ${username} : nom d'utilisateur sur le serveur, ${realname} : nom réel sur le serveur
-
type: string
-
values: any string
-
default value:
"${time}"
-
-
-
description: format de réponse CTCP ou une chaîne vide pour bloquer le CTCP (pas de réponse) ; le contenu est évalué, voir /help eval ; les variables suivantes sont remplacées : ${clientinfo} : liste des CTCP supportés, ${version} : version de WeeChat, ${git} : version Git, ${versiongit} : version de WeeChat et version Git, ${compilation} : date de compilation, ${osinfo} : information sur l'OS, ${site} : site de WeeChat, ${download} : page de téléchargement du site de WeeChat, ${time} : date et heure courante sous forme de texte, ${username} : nom d'utilisateur sur le serveur, ${realname} : nom réel sur le serveur
-
type: string
-
values: any string
-
default value:
"WeeChat ${version}"
-
-
irc.look.buffer_open_before_autojoin
-
description: open channel buffer before the JOIN is received from server when it is auto joined (with server option "autojoin"); this is useful to open channels with always the same buffer numbers on startup
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.buffer_open_before_join
-
description: open channel buffer before the JOIN is received from server when it is manually joined (with /join command)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
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
-
-
-
description: auto switch to channel buffer when it is manually joined (with /join command)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
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
-
-
-
description: time format used in answer to message CTCP TIME (see man strftime for date/time specifiers, extra specifiers are supported, see function util_strftimeval in Plugin API reference)
-
type: string
-
values: any string
-
default value:
"%a, %d %b %Y %T %z"
-
-
irc.look.display_account_message
-
description: display ACCOUNT messages received when capability account-notify is enabled
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display message when (un)marking as away (off: do not display/send anything, local: display locally, channel: send action to channels)
-
type: enum
-
values: off, local, channel
-
default value:
local
-
-
-
description: display CTCP message even if it is blocked
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display CTCP reply sent by WeeChat
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display CTCP message even if it is unknown CTCP
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.display_extended_join
-
description: display extra information in the JOIN messages: account name and real name (capability extended-join must be enabled)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
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
-
-
-
description: display host in notice messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display host in part/quit messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display host in wallops messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: comma-separated list of messages to display after joining a channel: 324 = channel modes, 329 = channel creation date, 332 = topic, 333 = nick/date for topic, 353 = names on channel, 366 = names count
-
type: string
-
values: any string
-
default value:
"329,332,333,366"
-
-
-
description: display old topic when channel topic is changed
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display remote away message only once in private
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display a message in private when user is back (after quit on server)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.display_pv_nick_change
-
description: display nick change in private
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.display_pv_warning_address
-
description: display a warning in private buffer if the address of remote nick has changed; this option is disabled by default because servers like bitlbee are causing this warning to be displayed when it is not expected (the address of remote nick changes multiple times on login)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
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 values), these words are added to buffer property "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"
-
-
-
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 values), these words are added to buffer property "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"
-
-
-
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 values), these words are added to buffer property "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_restrict
-
description: restrict highlights to these tags on irc buffers (to have highlight on user messages but not server messages); tags must be separated by a comma and "+" can be used to make a logical "and" between tags; wildcard "*" is allowed in tags; an empty value allows highlight on any tag
-
type: string
-
values: any string
-
default value:
"irc_privmsg,irc_notice"
-
-
-
description: add tag "irc_ignored" in ignored messages instead of removing them; that way messages can be filtered with /filter command and toggled on-demand
-
type: boolean
-
values: on, off
-
default value:
off
-
-
irc.look.item_channel_modes_hide_args
-
description: hide channel modes arguments if at least one of these modes is in channel modes ("*" to always hide all arguments, empty value to never hide arguments); example: "kf" to hide arguments if "k" or "f" are in channel modes
-
type: string
-
values: any string
-
default value:
"k"
-
-
-
description: name of bar item where IRC server is displayed (for status bar)
-
type: enum
-
values: buffer_plugin, buffer_name
-
default value:
buffer_plugin
-
-
-
description: display nick modes in bar item "input_prompt"
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: display nick prefix in bar item "input_prompt"
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.join_auto_add_chantype
-
description: automatically add channel type in front of channel name on command /join if the channel name does not start with a valid channel type for the server; for example: "/join weechat" will in fact send: "/join #weechat"
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: use a dedicated buffer for the output of /list
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.list_buffer_format_export
-
description: format of each channel exported in a file (note: content is evaluated, see /help list)
-
type: string
-
values: any string
-
default value:
"${name} (${users}): \"${topic}\""
-
-
irc.look.list_buffer_scroll_horizontal
-
description: left/right scroll in /list buffer (percent of width)
-
type: integer
-
values: 1 .. 100
-
default value:
10
-
-
-
description: comma-separated list of fields to sort channels (see /help list for a list of fields); char "-" can be used before field to reverse order, char "~" can be used to do a case-insensitive comparison; example: "-count,~name" for biggest channels first then case-insensitive sort on name
-
type: string
-
values: any string
-
default value:
"~name2"
-
-
irc.look.list_buffer_topic_strip_colors
-
description: strip channel topic colors in /list buffer
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: default target buffer for msgbuffer options when target is private and that private buffer is not found
-
type: enum
-
values: current, server
-
default value:
current
-
-
-
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: enum
-
values: none, next, near_server
-
default value:
none
-
-
-
description: force position of new /list buffer in list of buffers (none = default position (should be last buffer), next = current buffer + 1, near_server = after last channel/pv of server)
-
type: enum
-
values: none, next, near_server
-
default value:
none
-
-
-
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: enum
-
values: none, next, near_server
-
default value:
none
-
-
irc.look.nick_completion_smart
-
description: smart completion for nicks (completes first with last speakers): speakers = all speakers (including highlights), speakers_highlights = only speakers with highlight
-
type: enum
-
values: off, speakers, speakers_highlights
-
default value:
speakers
-
-
-
description: display nick mode (op, voice, ...) before nick (none = never, prefix = in prefix only (default), action = in action messages only, both = prefix + action messages)
-
type: enum
-
values: none, prefix, action, both
-
default value:
prefix
-
-
-
description: display a space if nick mode is enabled but nick has no mode (not op, voice, ...)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: comma separated list of nicks for which passwords will be hidden when a message is sent, for example to hide password in message displayed by "/msg nickserv identify password", example: "nickserv,nickbot"
-
type: string
-
values: any string
-
default value:
"nickserv"
-
-
-
description: display notices as private messages (if auto, use private buffer if found)
-
type: enum
-
values: auto, never, always
-
default value:
auto
-
-
irc.look.notice_nicks_disable_notify
-
description: comma separated list of nicks for which notifications are disabled in notice messages (comparison is case-insensitive)
-
type: string
-
values: any string
-
default value:
"chanserv,nickserv"
-
-
irc.look.notice_welcome_redirect
-
description: automatically redirect channel welcome notices to the channel buffer; such notices have the nick as target but a channel name in beginning of notice message, for example the ENTRYMSG notices sent by Atheme IRC Services which look like: "[#channel] Welcome to this channel..."
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: comma separated list of tags used in a welcome notices redirected to a channel, for example: "notify_private"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: comma separated list of tags used in messages displayed by notify when a nick joins or quits server (result of command ison or monitor), for example: "notify_message", "notify_private" or "notify_highlight"
-
type: string
-
values: any string
-
default value:
"notify_message"
-
-
-
description: comma separated list of tags used in messages displayed by notify when a nick away status changes (result of command whois), for example: "notify_message", "notify_private" or "notify_highlight"
-
type: string
-
values: any string
-
default value:
"notify_message"
-
-
irc.look.open_pv_buffer_echo_msg
-
description: open a private buffer on self message when capability echo-message is enabled
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: close buffer when /part is issued on a channel
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: merge private buffers
-
type: enum
-
values: independent, merge_by_server, merge_all
-
default value:
independent
-
-
-
description: comma separated list of tags used in private messages, for example: "notify_message", "notify_private" or "notify_highlight"
-
type: string
-
values: any string
-
default value:
"notify_private"
-
-
-
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
-
-
-
description: merge server buffers; this option has no effect if a layout is saved and is conflicting with this value (see /help layout)
-
type: enum
-
values: merge_with_core, merge_without_core, independent
-
default value:
merge_with_core
-
-
-
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", see /help filter)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: enable smart filter for "account" messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: enable smart filter for "chghost" messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: delay for filtering join/part/quit messages (in minutes): if the nick did not speak during the last N minutes, the join/part/quit is filtered
-
type: integer
-
values: 1 .. 10080
-
default value:
5
-
-
-
description: enable smart filter for "join" messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.look.smart_filter_join_unmask
-
description: delay for unmasking a join message that was filtered with tag "irc_smart_filter" (in minutes): if a nick has joined max N minutes ago and then says something on channel (message, notice or update on topic), the join is unmasked, as well as nick changes after this join (0 = disable: never unmask a join)
-
type: integer
-
values: 0 .. 10080
-
default value:
30
-
-
-
description: enable smart filter for "mode" messages: "*" to filter all modes, "+" to filter all modes in server prefixes (for example "ovh"), "xyz" to filter only modes x/y/z, "-xyz" to filter all modes but not x/y/z; examples: "ovh": filter modes o/v/h, "-bkl": filter all modes but not b/k/l
-
type: string
-
values: any string
-
default value:
""+
-
-
-
description: enable smart filter for "nick" messages (nick changes)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: enable smart filter for "part" and "quit" messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: enable smart filter for "setname" messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: enable automatic addition of temporary servers with command /connect
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: strip colors in topic (used only when displaying buffer title)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: display nicks typing on the channel in bar item "typing" (option typing.look.enabled_nicks must be enabled and capability "message-tags" must be enabled on the server)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: send self typing status to channels so that other users see when you are typing a message (option typing.look.enabled_self must be enabled and capability "message-tags" must be enabled on the server)
-
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, etc.)
-
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 .. 604800
-
default value:
600
-
-
-
description: default ban mask for commands /ban, /unban and /kickban; variables $nick, $user, $ident and $host are replaced by their values (extracted from "nick!user@host"); $ident is the same as $user if $user does not start with "~", otherwise it is set to "*"; this default mask is used only if WeeChat knows the host for the nick
-
type: string
-
values: any string
-
default value:
"*!$ident@$host"
-
-
-
description: when off, colors codes are ignored in incoming messages
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: allow user to send colors with special codes (ctrl-c + a code and optional color: b=bold, cxx=color, cxx,yy=color+background, i=italic, o=disable color/attributes, r=reverse, u=underline)
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: interval between two checks for lag (in seconds, 0 = never check)
-
type: integer
-
values: 0 .. 604800
-
default value:
60
-
-
-
description: maximum lag (in seconds): if this lag is reached, WeeChat will consider that the answer from server (pong) will never be received and will give up counting the lag (0 = never give up)
-
type: integer
-
values: 0 .. 604800
-
default value:
1800
-
-
-
description: minimum lag to show (in milliseconds)
-
type: integer
-
values: 0 .. 86400000
-
default value:
500
-
-
-
description: reconnect to server if lag is greater than or equal to this value (in seconds, 0 = never reconnect); this value must be less than or equal to irc.network.lag_max
-
type: integer
-
values: 0 .. 604800
-
default value:
300
-
-
irc.network.lag_refresh_interval
-
description: interval between two refreshes of lag item, when lag is increasing (in seconds)
-
type: integer
-
values: 1 .. 3600
-
default value:
1
-
-
-
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.sasl_fail_unavailable
-
description: cause SASL authentication failure when SASL is requested but unavailable on the server; when this option is enabled, it has effect only if option "sasl_fail" is set to "reconnect" or "disconnect" in the server
-
type: boolean
-
values: on, off
-
default value:
on
-
-
irc.network.send_unknown_commands
-
description: send unknown commands to server
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: double the nick in /whois command (if only one nick is given), to get idle time in answer; for example: "/whois nick" will send "whois nick nick"
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: list of hostname/port or IP/port for server (separated by comma) (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: delay in milliseconds between two messages sent to server (anti-flood protection); 0 = disable protection and always send messages immediately (not recommended because the server can close the connection if you send several messages in a short time); internally there are queues with different priorities: when connecting to the server all messages are sent immediately and your messages have higher priority than some automatic messages that are sent in background by WeeChat
-
type: integer
-
values: 0 .. 60000
-
default value:
2000
-
-
irc.server_default.autoconnect
-
description: automatically connect to server when WeeChat is starting
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: comma separated list of channels to join after connection to server (and after executing command + delay if they are set); the channels that require a key must be at beginning of the list, and all the keys must be given after the channels (separated by a space) (example: "#channel1,#channel2,#channel3 key1,key2" where #channel1 and #channel2 are protected by key1 and key2) (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.autojoin_delay
-
description: delay (in seconds) before auto-join of channels (example: give some time for authentication before joining channels)
-
type: integer
-
values: 0 .. 3600
-
default value:
0
-
-
irc.server_default.autojoin_dynamic
-
description: set automatically the "autojoin" option according to the channels you manually join and part with commands /join and /part
-
type: boolean
-
values: on, off
-
default value:
off
-
-
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
-
-
-
description: automatically rejoin channels after kick; you can define a buffer local variable on a channel to override this value (name of variable: "autorejoin", value: "on" or "off")
-
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
-
-
-
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 (see /help cap for a list of capabilities supported by WeeChat); "*" enables all capabilities by default (supported by both server and WeeChat); wildcard "*" is allowed; a capability beginning with "!" is excluded (example: "*,!account-*,!extended-join")
-
type: string
-
values: any string
-
default value:
"*"
-
-
irc.server_default.charset_message
-
description: part of the IRC message (received or sent) which is decoded/encoded to the target charset; message = the whole IRC message (default), channel = starting from the channel name only (if found, with fallback on text), text = starting from the text only (you should try this value if you have issues with the channel name encoding)
-
type: enum
-
values: message, channel, text
-
default value:
message
-
-
-
description: command(s) to run after connection to server and before auto-join of channels (many commands can be separated by ";", use "\;" for a semicolon, special variables $nick, $channel and $server are replaced by their values) (note: commands are evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.command_delay
-
description: delay (in seconds) before execution of command
-
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_chantypes
-
description: channel type prefixes to use if the server does not send them in message 005 (default is "#&")
-
type: string
-
values: any string
-
default value:
"#&"
-
-
-
description: use IPv6 protocol for server communication
-
type: enum
-
values: disable, auto, force
-
default value:
auto
-
-
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:
""
-
-
-
description: default kick message used by commands "/kick" and "/kickban" (note: content is evaluated, see /help eval; special variables ${nick} (self nick), ${target} (target nick), ${channel} and ${server} are replaced by their values)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: default part message (leaving channel) (note: content is evaluated, see /help eval; special variables ${nick}, ${channel} and ${server} are replaced by their values; "%v" is replaced by WeeChat version if there is no ${...} in string)
-
type: string
-
values: any string
-
default value:
"WeeChat ${info:version}"
-
-
-
description: default quit message (disconnecting from server) (note: content is evaluated, see /help eval; special variables ${nick}, ${channel} and ${server} are replaced by their values; "%v" is replaced by WeeChat version if there is no ${...} in string)
-
type: string
-
values: any string
-
default value:
"WeeChat ${info:version}"
-
-
-
description: nicknames to use on server (separated by comma) (note: content is evaluated, see /help eval; ${username} is replaced by system username (fallback to "weechat" if not found), server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
"${username},${username}2,${username}3,${username}4,${username}5"
-
-
irc.server_default.nicks_alternate
-
description: get an alternate nick when all the declared nicks are already used on server: add some "_" until the nick has a length of 9, and then replace last char (or the two last chars) by a number from 1 to 99, until we find a nick not used on server
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: notify list for server (you should not change this option but use /notify command instead)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: password for server (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: name of proxy used for this server (optional, proxy must be defined with command /proxy)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: real name to use on server (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.registered_mode
-
description: mode that is set on registered users (default is "r")
-
type: string
-
values: any string
-
default value:
"r"
-
-
-
description: action to perform if SASL authentication fails: "continue" to ignore the authentication problem, "reconnect" to schedule a reconnection to the server, "disconnect" to disconnect from server (see also option irc.network.sasl_fail_unavailable)
-
type: enum
-
values: continue, reconnect, disconnect
-
default value:
reconnect
-
-
-
description: file with ECC private key for mechanism "ecdsa-nist256p-challenge" (path is evaluated, see function string_eval_path_home in plugin API reference)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.sasl_mechanism
-
description: mechanism for SASL authentication: "plain" for plain text password, "scram-sha-1" for SCRAM authentication with SHA-1 digest algorithm, "scram-sha-256" for SCRAM authentication with SHA-256 digest algorithm, "scram-sha-512" for SCRAM authentication with SHA-512 digest algorithm, "ecdsa-nist256p-challenge" for key-based challenge authentication, "external" for authentication using client side TLS certificate
-
type: enum
-
values: plain, scram-sha-1, scram-sha-256, scram-sha-512, ecdsa-nist256p-challenge, external
-
default value:
plain
-
-
irc.server_default.sasl_password
-
description: password for SASL authentication; this option is not used for mechanisms "ecdsa-nist256p-challenge" and "external" (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
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; this option is not used for mechanism "external" (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.split_msg_max_length
-
description: split outgoing IRC messages to fit in this number of chars; the default value is 512, this is a safe and recommended value; value 0 disables the split (not recommended, unless you know what you do); allowed values are 0 or any integer between 128 and 4096; this option should be changed only on non-standard IRC servers, for example gateways like bitlbee
-
type: integer
-
values: 0 .. 4096
-
default value:
512
-
-
-
description: use TLS for server communication
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: TLS certificate file used to automatically identify your nick (path is evaluated, see function string_eval_path_home in plugin API reference)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.tls_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.tls_fingerprint
-
description: fingerprint of certificate which is trusted and accepted for the server; only hexadecimal digits are allowed (0-9, a-f): 128 chars for SHA-512, 64 chars for SHA-256, 40 chars for SHA-1 (insecure, not recommended); many fingerprints can be separated by commas; if this option is set, the other checks on certificates are NOT performed (option "tls_verify") (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.tls_password
-
description: password for TLS certificate's private key; only used with gnutls version >= 3.1.0 (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
irc.server_default.tls_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"
-
-
-
description: check that the TLS connection is fully trusted
-
type: boolean
-
values: on, off
-
default value:
on
-
-
-
description: user mode(s) to set after connection to server and before executing command and the auto-join of channels; examples: "+R" (to set mode "R"), "+R-i" (to set mode "R" and remove "i"); see /help mode for the complete mode syntax (note: content is evaluated, see /help eval; server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: user name to use on server (note: content is evaluated, see /help eval; ${username} is replaced by system username (fallback to "weechat" if not found), server options are evaluated with ${irc_server.xxx} and ${server} is replaced by the server name)
-
type: string
-
values: any string
-
default value:
"${username}"
-
9. Xfer
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
9.1. 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.
9.2. Options
Sections in file xfer.conf:
Section | Control command | Description |
---|---|---|
|
|
Look and feel. |
|
|
Colors. |
|
|
Network options. |
|
|
Options for files sent/received. |
Options:
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightred
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightblue
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
yellow
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightgreen
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightred
-
-
-
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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
lightcyan
-
-
-
description: text color in xfer 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: background color in xfer 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
default
-
-
-
description: text color of selected line in xfer 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 blink, "." for "dim" (half bright), "*" for bold, "!" for reverse, "/" for italic, "_" for underline
-
default value:
white
-
-
-
description: automatically accept chat requests (use carefully!)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: automatically accept incoming files (use carefully!)
-
type: boolean
-
values: on, off
-
default value:
off
-
-
-
description: comma-separated list of nicks for which the incoming files and chats are automatically accepted; format is "server.nick" (for a specific server) or "nick" (for all servers); example: "libera.FlashCode,andrew"
-
type: string
-
values: any string
-
default value:
""
-
-
-
description: automatically check CRC32 file checksum if it is found in the filename (8 hex
-