1134 lines
32 KiB
Plaintext
1134 lines
32 KiB
Plaintext
= WeeChat FAQ (Frequently Asked Questions)
|
|
:author: Sébastien Helleu
|
|
:email: flashcode@flashtux.org
|
|
:lang: en
|
|
:toc: left
|
|
:toclevels: 2
|
|
:sectnums:
|
|
:sectnumlevels: 2
|
|
:docinfo1:
|
|
|
|
|
|
This document is written for WeeChat versions ≥ 0.3.0 but should preferably be
|
|
used with latest stable version of WeeChat.
|
|
|
|
toc::[]
|
|
|
|
|
|
[[general]]
|
|
== General
|
|
|
|
[[weechat_name]]
|
|
=== Where does the name "WeeChat" come from?
|
|
|
|
"Wee" is a recursive acronym and stands for "Wee Enhanced Environment".
|
|
So complete name is "Wee Enhanced Environment for Chat".
|
|
|
|
"Wee" also means "very small" (and yes, there is other meaning, but it does not
|
|
apply to WeeChat!).
|
|
|
|
[[why_choose_weechat]]
|
|
=== Why choose WeeChat? X-Chat and Irssi are so good...
|
|
|
|
Because WeeChat is very light and brings innovating features.
|
|
|
|
More info on the WeeChat features page: https://weechat.org/about/features
|
|
|
|
[[compilation_install]]
|
|
== Compilation / install
|
|
|
|
[[gui]]
|
|
=== I've heard about many GUIs for WeeChat. How can I compile/use them?
|
|
|
|
Some remote GUIs are available, see the remote interfaces page:
|
|
https://weechat.org/about/interfaces
|
|
|
|
[[compile_git]]
|
|
=== I can't compile WeeChat after cloning git repository, why?
|
|
|
|
The recommended way to compile WeeChat is with
|
|
link:weechat_user.en.html#compile_with_cmake[cmake].
|
|
|
|
If you're compiling with link:weechat_user.en.html#compile_with_autotools[autotools]
|
|
(and not cmake), check that you have latest version of autoconf and automake.
|
|
|
|
The other way is to install the "devel package", which needs less dependencies.
|
|
This package is built almost every day using git repository. Note that this
|
|
package may not correspond exactly to git base and that it's less convenient
|
|
than git cloning for installing updates.
|
|
|
|
[[compile_macos]]
|
|
=== How can I install WeeChat on macOS?
|
|
|
|
It is recommended to use https://brew.sh/[Homebrew], you can get help with:
|
|
|
|
----
|
|
brew info weechat
|
|
----
|
|
|
|
You can install WeeChat with this command:
|
|
|
|
----
|
|
brew install weechat --with-aspell --with-curl --with-python --with-perl --with-ruby --with-lua --with-guile
|
|
----
|
|
|
|
[[lost]]
|
|
=== I've launched WeeChat, but I'm lost, what can I do?
|
|
|
|
For help you can type `/help`. For help about a command, type `/help command`.
|
|
link:weechat_user.en.html#key_bindings[Keys] and
|
|
link:weechat_user.en.html#commands_and_options[commands] are listed
|
|
in documentation.
|
|
|
|
It's recommended for new users to read the
|
|
link:weechat_quickstart.en.html[Quickstart guide].
|
|
|
|
[[display]]
|
|
== Display
|
|
|
|
[[charset]]
|
|
=== I don't see some chars with accents, what can I do?
|
|
|
|
It's a common issue with a variety of causes, please read carefully and check
|
|
*ALL* solutions below:
|
|
|
|
* Check that weechat is linked to libncursesw (warning: needed on most
|
|
distributions but not all): `ldd /path/to/weechat`.
|
|
* Check that the "charset" plugin is loaded with `/plugin` command (if it is
|
|
not, then you probably need the "weechat-plugins" package).
|
|
* Check the output of command `/charset` (on core buffer). You should see
|
|
_ISO-XXXXXX_ or _UTF-8_ for terminal charset. If you see _ANSI_X3.4-1968_ or
|
|
other values, your locale is probably wrong. +
|
|
To fix your locale, check the installed locales with `locale -a` and set
|
|
an appropriate value in $LANG, for example: `export LANG=en_US.UTF-8`.
|
|
* Setup global decode value, for example:
|
|
`/set charset.default.decode "ISO-8859-15"`.
|
|
* If you are using UTF-8 locale:
|
|
** Check that your terminal is UTF-8 ready (terminal recommended for UTF-8 is
|
|
rxvt-unicode).
|
|
** If you are using screen, check that it is run with UTF-8 mode
|
|
("`defutf8 on`" in ~/.screenrc or `screen -U` to run screen).
|
|
* Check that option
|
|
link:weechat_user.en.html#option_weechat.look.eat_newline_glitch[_weechat.look.eat_newline_glitch_]
|
|
is off (this option may cause display bugs).
|
|
|
|
[NOTE]
|
|
UTF-8 locale is recommended for WeeChat. If you're using ISO or other
|
|
locale, please check that *all* your settings (terminal, screen, ..) are ISO
|
|
and *not* UTF-8.
|
|
|
|
[[unicode_chars]]
|
|
=== Some unicode chars are displayed in terminal but not in WeeChat, why?
|
|
|
|
This may be caused by a libc bug in function _wcwidth_, which should be fixed
|
|
in glibc 2.22 (maybe not yet available in your distribution).
|
|
|
|
There is a workaround to use the fixed _wcwidth_ function:
|
|
https://blog.nytsoi.net/2015/05/04/emoji-support-for-weechat
|
|
|
|
See this bug report for more information:
|
|
https://github.com/weechat/weechat/issues/79
|
|
|
|
[[bars_background]]
|
|
=== Bars like title and status are not filled, background color stops after text, why?
|
|
|
|
This may be caused by a bad value of the TERM variable in your shell (look at
|
|
the output of `echo $TERM` in your terminal).
|
|
|
|
Depending on where you launch WeeChat, you should have:
|
|
|
|
* If WeeChat runs locally or on a remote machine without screen nor tmux, it
|
|
depends on the terminal used: _xterm_, _xterm-256color_, _rxvt-unicode_,
|
|
_rxvt-256color_, etc.
|
|
* If WeeChat runs under screen, you should have _screen_ or _screen-256color_.
|
|
* If WeeChat runs under tmux, you should have _tmux_, _tmux-256color_,
|
|
_screen_ or _screen-256color_.
|
|
|
|
If needed, fix your TERM variable: `export TERM="xxx"`.
|
|
|
|
[[screen_weird_chars]]
|
|
=== When I'm using weechat under screen/tmux, I have weird random chars, how do I fix that?
|
|
|
|
This may be caused by bad value of the TERM variable in your shell (look at
|
|
output of `echo $TERM` in your terminal, *outside screen/tmux*). +
|
|
For example, _xterm-color_ may display such weird chars, you can use _xterm_
|
|
which is OK (like many other values). +
|
|
If needed, fix your TERM variable: `export TERM="xxx"`.
|
|
|
|
If you are using gnome-terminal, check that the option
|
|
"Ambiguous-width characters" in menu Preferences/Profile/Compatibility
|
|
is set to `narrow`.
|
|
|
|
[[macos_display_broken]]
|
|
=== I compiled WeeChat under macOS, and I see "(null)" everywhere on screen, what's wrong?
|
|
|
|
If you compiled ncursesw yourself, try to use standard ncurses (that comes with
|
|
system).
|
|
|
|
Moreover, under macOS, it is recommended to install WeeChat with Homebrew
|
|
package manager.
|
|
|
|
[[buffer_vs_window]]
|
|
=== I've heard about "buffers" and "windows", what's the difference?
|
|
|
|
A _buffer_ is composed by a number, a name, lines displayed (and some other
|
|
data).
|
|
|
|
A _window_ is a screen area which displays a buffer. It is possible to split
|
|
your screen into many windows.
|
|
|
|
Each window displays one buffer, or a set of merged buffers.
|
|
A buffer can be hidden (not displayed by a window) or displayed by one or more
|
|
windows.
|
|
|
|
[[buffers_list]]
|
|
=== How to display the buffers list on the left side?
|
|
|
|
With WeeChat ≥ 1.8, the plugin link:weechat_user.en.html#buflist_plugin[buflist]
|
|
is loaded and enabled by default.
|
|
|
|
With an older version, you can install script _buffers.pl_:
|
|
|
|
----
|
|
/script install buffers.pl
|
|
----
|
|
|
|
To limit size of bar (replace "buflist" by "buffers" if you're using the script
|
|
_buffers.pl_):
|
|
|
|
----
|
|
/set weechat.bar.buflist.size_max 15
|
|
----
|
|
|
|
To move bar to bottom:
|
|
|
|
----
|
|
/set weechat.bar.buflist.position bottom
|
|
----
|
|
|
|
To scroll the bar: if mouse is enabled (key: kbd:[Alt+m]), you can scroll the
|
|
bar with your mouse wheel.
|
|
|
|
Default keys to scroll _buflist_ bar are kbd:[F1], kbd:[F2], kbd:[Alt+F1]
|
|
and kbd:[Alt+F2].
|
|
|
|
For script _buffers.pl_, you can define keys, similar to the existing keys to
|
|
scroll nicklist. +
|
|
For example to use kbd:[F1], kbd:[F2], kbd:[Alt+F1] and kbd:[Alt+F2]:
|
|
|
|
----
|
|
/key bind meta-OP /bar scroll buffers * -100%
|
|
/key bind meta-OQ /bar scroll buffers * +100%
|
|
/key bind meta-meta-OP /bar scroll buffers * b
|
|
/key bind meta-meta-OQ /bar scroll buffers * e
|
|
----
|
|
|
|
[NOTE]
|
|
Keys "meta-OP" and "meta-OQ" may be different in your terminal. To find key
|
|
code press kbd:[Alt+k] then key.
|
|
|
|
[[customize_prefix]]
|
|
=== How can I reduce length of nicks or remove nick alignment in chat area?
|
|
|
|
To reduce max length of nicks in chat area:
|
|
|
|
----
|
|
/set weechat.look.prefix_align_max 15
|
|
----
|
|
|
|
To remove nick alignment:
|
|
|
|
----
|
|
/set weechat.look.prefix_align none
|
|
----
|
|
|
|
[[status_hotlist]]
|
|
=== What does the [H: 3(1,8), 2(4)] in status bar mean?
|
|
|
|
This is called the "hotlist", a list of buffers with the number of unread
|
|
messages, by order: highlights, private messages, messages, other messages
|
|
(like join/part). +
|
|
The number of "unread message" is the number of new messages displayed/received
|
|
since you visited the buffer.
|
|
|
|
In the example `[H: 3(1,8), 2(4)]`, there are:
|
|
|
|
* 1 highlight and 8 unread messages on buffer #3,
|
|
* 4 unread messages on buffer #2.
|
|
|
|
The color of the buffer/counter depends on the type of message, default colors
|
|
are:
|
|
|
|
* highlight: `lightmagenta` / `magenta`
|
|
* private message: `lightgreen` / `green`
|
|
* message: `yellow` / `brown`
|
|
* other message: `default` / `default` (color of text in terminal)
|
|
|
|
These colors can be changed with the options __weechat.color.status_data_*__
|
|
(buffers) and __weechat.color.status_count_*__ (counters). +
|
|
Other hotlist options can be changed with the options __weechat.look.hotlist_*__.
|
|
|
|
See link:weechat_user.en.html#screen_layout[User's guide / Screen layout] for
|
|
more info about the hotlist.
|
|
|
|
[[input_bar_size]]
|
|
=== How to use command line with more than one line?
|
|
|
|
The option _size_ in input bar can be set to a value higher than 1 (for fixed
|
|
size, default size is 1) or 0 for dynamic size, and then option _size_max_ will
|
|
set the max size (0 = no limit).
|
|
|
|
Example with dynamic size:
|
|
|
|
----
|
|
/set weechat.bar.input.size 0
|
|
----
|
|
|
|
Max size of 2:
|
|
|
|
----
|
|
/set weechat.bar.input.size_max 2
|
|
----
|
|
|
|
[[one_input_root_bar]]
|
|
=== Is it possible to display only one input bar for all windows (after split)?
|
|
|
|
Yes, you will have to create a bar with type "root" (with an item to know in
|
|
which window you are), then delete current input bar.
|
|
|
|
For example:
|
|
|
|
----
|
|
/bar add rootinput root bottom 1 0 [buffer_name]+[input_prompt]+(away),[input_search],[input_paste],input_text
|
|
/bar del input
|
|
----
|
|
|
|
If ever you are not satisfied with that, just delete new bar, WeeChat will
|
|
automatically create default bar "input" if item "input_text" is not used in
|
|
any bar:
|
|
|
|
----
|
|
/bar del rootinput
|
|
----
|
|
|
|
[[terminal_copy_paste]]
|
|
=== How can I copy/paste text without pasting nicklist?
|
|
|
|
With WeeChat ≥ 1.0, you can use the bare display (default key: kbd:[Alt+l]),
|
|
which will show just the contents of the currently selected window,
|
|
without any formatting.
|
|
|
|
You can use a terminal with rectangular selection (like rxvt-unicode,
|
|
konsole, gnome-terminal, etc.). Key is usually kbd:[Ctrl] + kbd:[Alt] + mouse
|
|
selection.
|
|
|
|
Another solution is to move nicklist to top or bottom, for example:
|
|
|
|
----
|
|
/set weechat.bar.nicklist.position top
|
|
----
|
|
|
|
[[urls]]
|
|
=== How can I click on long URLs (more than one line)?
|
|
|
|
With WeeChat ≥ 1.0, you can use the bare display (default key: kbd:[Alt+l]).
|
|
|
|
To make opening URLs easier, you can:
|
|
|
|
* move nicklist to top:
|
|
|
|
----
|
|
/set weechat.bar.nicklist.position top
|
|
----
|
|
|
|
* disable alignment for multiline words (WeeChat ≥ 1.7):
|
|
|
|
----
|
|
/set weechat.look.align_multiline_words off
|
|
----
|
|
|
|
* or for all wrapped lines:
|
|
|
|
----
|
|
/set weechat.look.align_end_of_lines time
|
|
----
|
|
|
|
With WeeChat ≥ 0.3.6, you can enable option "eat_newline_glitch", so that
|
|
new line char is not added at the end of each line displayed (it will not break
|
|
URL selection):
|
|
|
|
----
|
|
/set weechat.look.eat_newline_glitch on
|
|
----
|
|
|
|
[IMPORTANT]
|
|
This option may cause display bugs. If you experience such problem, you must
|
|
turn off this option.
|
|
|
|
Other solution is to use a script:
|
|
|
|
----
|
|
/script search url
|
|
----
|
|
|
|
[[change_locale_without_quit]]
|
|
=== I want to change the language used by WeeChat for messages, but without exiting WeeChat, is it possible?
|
|
|
|
Yes, with WeeChat ≥ 1.0:
|
|
|
|
----
|
|
/set env LANG en_US.UTF-8
|
|
/upgrade
|
|
----
|
|
|
|
With older WeeChat:
|
|
|
|
----
|
|
/script install shell.py
|
|
/shell setenv LANG=en_US.UTF-8
|
|
/upgrade
|
|
----
|
|
|
|
[[use_256_colors]]
|
|
=== How can I use 256 colors in WeeChat?
|
|
|
|
256 colors are supported with WeeChat ≥ 0.3.4.
|
|
|
|
First check that your _TERM_ environment variable is correct, recommended values
|
|
are:
|
|
|
|
* 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 a wrong value and that WeeChat is already running,
|
|
you can change it with these two commands (with WeeChat ≥ 1.0):
|
|
|
|
----
|
|
/set env TERM screen-256color
|
|
/upgrade
|
|
----
|
|
|
|
For version 0.3.4, you must use command `/color` to add new colors.
|
|
|
|
For versions ≥ 0.3.5, you can use any color number in options (optional: you
|
|
can add color aliases with command `/color`).
|
|
|
|
Please read the link:weechat_user.en.html#colors[User's guide / Colors] for more
|
|
information about colors management.
|
|
|
|
[[search_text]]
|
|
=== How can I search text in buffer (like /lastlog in irssi)?
|
|
|
|
The default key is kbd:[Ctrl+r] (command is: `/input search_text_here`).
|
|
And jump to highlights: kbd:[Alt+p] / kbd:[Alt+n].
|
|
|
|
See link:weechat_user.en.html#key_bindings[User's guide / Key bindings] for more
|
|
info about this feature.
|
|
|
|
[[terminal_focus]]
|
|
=== How can I execute commands when terminal gets/loses focus?
|
|
|
|
You must enable the focus events with a special code sent to terminal.
|
|
|
|
*Important*:
|
|
|
|
* You must use a modern xterm-compatible terminal.
|
|
* Additionally, it seems to be important that your value of the TERM variable
|
|
equals to _xterm_ or _xterm-256color_.
|
|
* If you use tmux, you must additionally enable focus events by adding
|
|
`set -g focus-events on` to your _.tmux.conf_ file.
|
|
* This does *not* work under screen.
|
|
|
|
To send the code when WeeChat is starting:
|
|
|
|
----
|
|
/set weechat.startup.command_after_plugins "/print -stdout \033[?1004h\n"
|
|
----
|
|
|
|
And then you bind two keys for the focus (replace the `/print` commands by the
|
|
commands of your choice):
|
|
|
|
----
|
|
/key bind meta2-I /print -core focus
|
|
/key bind meta2-O /print -core unfocus
|
|
----
|
|
|
|
For example to mark buffers as read when the terminal loses the focus:
|
|
|
|
----
|
|
/key bind meta2-O /input set_unread
|
|
----
|
|
|
|
[[screen_paste]]
|
|
=== When WeeChat is running in screen, pasting text in another screen window adds ~0 and ~1 around text, why?
|
|
|
|
This is caused by the bracketed paste option which is enabled by default, and
|
|
not properly handled by screen in other windows.
|
|
|
|
You can just disable bracketed paste mode:
|
|
|
|
----
|
|
/set weechat.look.paste_bracketed off
|
|
----
|
|
|
|
[[key_bindings]]
|
|
== Key bindings
|
|
|
|
[[meta_keys]]
|
|
=== Some meta keys (alt + key) are not working, why?
|
|
|
|
If you're using some terminals like xterm or uxterm, some meta keys do not
|
|
work by default. You can add a line in file _~/.Xresources_:
|
|
|
|
* For xterm:
|
|
----
|
|
XTerm*metaSendsEscape: true
|
|
----
|
|
* For uxterm:
|
|
----
|
|
UXTerm*metaSendsEscape: true
|
|
----
|
|
|
|
And then reload resources (`xrdb -override ~/.Xresources`) or restart X.
|
|
|
|
If you are using the macOS Terminal app, enable the option
|
|
"Use option as meta key" in menu Settings/Keyboard after which you can use the
|
|
kbd:[Option] key as meta key.
|
|
|
|
[[customize_key_bindings]]
|
|
=== How can I customize key bindings?
|
|
|
|
Key bindings are customizable with `/key` command.
|
|
|
|
Default key kbd:[Alt+k] lets you grab key code and insert it in command line.
|
|
|
|
[[jump_to_buffer_11_or_higher]]
|
|
=== What is the key to jump to buffer 11 (or higher number)?
|
|
|
|
The key is kbd:[Alt+j] and then 2 digits, for example kbd:[Alt+j], kbd:[1],
|
|
kbd:[1] to jump to buffer 11.
|
|
|
|
You can bind a key, for example:
|
|
|
|
----
|
|
/key bind meta-q /buffer *11
|
|
----
|
|
|
|
List of default keys is in
|
|
link:weechat_user.en.html#key_bindings[User's guide / Key bindings].
|
|
|
|
To jump to buffers with number ≥ 100, you could define a trigger and then use
|
|
commands like `/123` to jump to buffer #123:
|
|
|
|
----
|
|
/trigger add numberjump modifier "2000|input_text_for_buffer" "${tg_string} =~ ^/[0-9]+$" "=\/([0-9]+)=/buffer *${re:1}=" "" "" "none"
|
|
----
|
|
|
|
[[global_history]]
|
|
=== How to use global history (instead of buffer history) with up and down keys?
|
|
|
|
You can bind the up and down keys on global history (default keys for global
|
|
history are kbd:[Ctrl+↑] and kbd:[Ctrl+↓]).
|
|
|
|
Example:
|
|
|
|
----
|
|
/key bind meta2-A /input history_global_previous
|
|
/key bind meta2-B /input history_global_next
|
|
----
|
|
|
|
[NOTE]
|
|
Keys "meta2-A" and "meta2-B" may be different in your terminal. To find key
|
|
code press kbd:[Alt+k] then key.
|
|
|
|
[[mouse]]
|
|
== Mouse
|
|
|
|
[[mouse_not_working]]
|
|
=== Mouse is not working at all, what can I do?
|
|
|
|
Mouse is supported with WeeChat ≥ 0.3.6.
|
|
|
|
First try to enable mouse:
|
|
|
|
----
|
|
/mouse enable
|
|
----
|
|
|
|
If mouse is still not working, check the TERM variable in your shell (look at
|
|
output of `echo $TERM` in your terminal).
|
|
According to terminfo used, mouse may not be supported.
|
|
|
|
You can test mouse support in terminal:
|
|
|
|
----
|
|
$ printf '\033[?1002h'
|
|
----
|
|
|
|
And then click on first char of terminal (upper left). You should see " !!#!!".
|
|
|
|
To disable mouse in terminal:
|
|
|
|
----
|
|
$ printf '\033[?1002l'
|
|
----
|
|
|
|
[[mouse_coords]]
|
|
=== Mouse does nothing for X or Y greater than 94 (or 222), why?
|
|
|
|
Some terminals are sending only ISO chars for mouse coordinates, so it does not
|
|
work for X/Y greater than 94 (or 222).
|
|
|
|
You should use a terminal that supports UTF-8 coordinates for mouse, like
|
|
rxvt-unicode.
|
|
|
|
[[mouse_select_paste]]
|
|
=== How can I select or paste text in terminal when mouse is enabled in WeeChat?
|
|
|
|
When mouse is enabled in WeeChat, you can use kbd:[Shift] modifier to select or
|
|
click in terminal, as if the mouse was disabled (on some terminals like iTerm,
|
|
you have to use kbd:[Alt] instead of kbd:[Shift]).
|
|
|
|
[[irc]]
|
|
== IRC
|
|
|
|
[[irc_ssl_connection]]
|
|
=== I have some problems when connecting to a server using SSL, what can I do?
|
|
|
|
If you are using macOS, you must install `openssl` from Homebrew.
|
|
A CA file will be bootstrapped using certificates from the system keychain.
|
|
You can then set the path to certificates in WeeChat:
|
|
|
|
----
|
|
/set weechat.network.gnutls_ca_file "/usr/local/etc/openssl/cert.pem"
|
|
----
|
|
|
|
If you see errors about gnutls handshake, you can try to use a smaller
|
|
Diffie-Hellman key (default is 2048):
|
|
|
|
----
|
|
/set irc.server.example.ssl_dhkey_size 1024
|
|
----
|
|
|
|
If you see errors about certificate, you can disable "ssl_verify" (be careful,
|
|
connection will be less secure by doing that):
|
|
|
|
----
|
|
/set irc.server.example.ssl_verify off
|
|
----
|
|
|
|
If the server has an invalid certificate and you know what the certificate
|
|
should be, you can specify the fingerprint (SHA-512, SHA-256 or SHA-1):
|
|
|
|
----
|
|
/set irc.server.example.ssl_fingerprint 0c06e399d3c3597511dc8550848bfd2a502f0ce19883b728b73f6b7e8604243b
|
|
----
|
|
|
|
[[irc_ssl_handshake_error]]
|
|
=== When connecting to server with SSL, I only see the error "TLS handshake failed", what can I do?
|
|
|
|
You can try a different priority string (WeeChat ≥ 0.3.5 only), replace "xxx"
|
|
by your server name:
|
|
|
|
----
|
|
/set irc.server.xxx.ssl_priorities "NORMAL:-VERS-TLS-ALL:+VERS-TLS1.0:+VERS-SSL3.0:%COMPAT"
|
|
----
|
|
|
|
[[irc_ssl_freenode]]
|
|
=== How can I connect to freenode server using SSL?
|
|
|
|
Set option _weechat.network.gnutls_ca_file_ to file with certificates:
|
|
|
|
----
|
|
/set weechat.network.gnutls_ca_file "/etc/ssl/certs/ca-certificates.crt"
|
|
----
|
|
|
|
Note: if you are running macOS with homebrew openssl installed, you can do:
|
|
|
|
----
|
|
/set weechat.network.gnutls_ca_file "/usr/local/etc/openssl/cert.pem"
|
|
----
|
|
|
|
[NOTE]
|
|
Check that you have this file on your system (commonly brought by package
|
|
"ca-certificates").
|
|
|
|
Setup server port, SSL, then connect:
|
|
|
|
----
|
|
/set irc.server.freenode.addresses "chat.freenode.net/7000"
|
|
/set irc.server.freenode.ssl on
|
|
/connect freenode
|
|
----
|
|
|
|
[[irc_oauth]]
|
|
=== How to connect to a server that requires "oauth"?
|
|
|
|
Some servers like _twitch_ require oauth to connect.
|
|
|
|
The oauth is simply a password with the value "oauth:XXXX".
|
|
|
|
You can add such server and connect with following commands (replace name
|
|
and address by appropriate values):
|
|
|
|
----
|
|
/server add name irc.server.org -password=oauth:XXXX
|
|
/connect name
|
|
----
|
|
|
|
[[irc_sasl]]
|
|
=== How can I be identified before joining channels?
|
|
|
|
If the server supports SASL, you should use that instead of sending the
|
|
command for nickserv authentication, for example:
|
|
|
|
----
|
|
/set irc.server.freenode.sasl_username "mynick"
|
|
/set irc.server.freenode.sasl_password "xxxxxxx"
|
|
----
|
|
|
|
If the server does not support SASL, you can add a delay (between command and
|
|
join of channels):
|
|
|
|
----
|
|
/set irc.server.freenode.command_delay 5
|
|
----
|
|
|
|
[[edit_autojoin]]
|
|
=== How can I add/remove channels from autojoin option?
|
|
|
|
You can use the `/set` command to edit the list of autojoin channels,
|
|
for example for the "freenode" server:
|
|
|
|
----
|
|
/set irc.server.freenode.autojoin [TAB]
|
|
----
|
|
|
|
[NOTE]
|
|
You can complete the name and value of option with the kbd:[Tab] key
|
|
(or kbd:[Shift+Tab] for partial completion, useful for the name). +
|
|
This way you don't have to type the whole list of channels.
|
|
|
|
You can also use the `/fset` command to edit the list of channels:
|
|
|
|
----
|
|
/fset autojoin
|
|
----
|
|
|
|
Another solution is to use a script:
|
|
|
|
----
|
|
/script search autojoin
|
|
----
|
|
|
|
[[ignore_vs_filter]]
|
|
=== What is the difference between the /ignore and /filter commands?
|
|
|
|
The `/ignore` command is an IRC command, so it applies only for IRC buffers
|
|
(servers and channels).
|
|
It lets you ignore some nicks or hostnames of users for a server or channel
|
|
(command will not apply on content of messages).
|
|
Matching messages are deleted by IRC plugin before display (so you'll
|
|
never see them, and can't be recovered by removing the ignore).
|
|
|
|
The `/filter` command is a WeeChat core command, so it applies to any buffer.
|
|
It lets you filter some lines in buffers with tags or regular expression for
|
|
prefix and content of line.
|
|
Filtered lines are only hidden, not deleted, and you can see them if you
|
|
disable filters (by default, the key kbd:[Alt+=] toggles filters).
|
|
|
|
[[filter_irc_join_part_quit]]
|
|
=== How can I filter join/part/quit messages on IRC channels?
|
|
|
|
With smart filter (keep join/part/quit from users who spoke recently):
|
|
|
|
----
|
|
/set irc.look.smart_filter on
|
|
/filter add irc_smart * irc_smart_filter *
|
|
----
|
|
|
|
With a global filter (hide *all* join/part/quit):
|
|
|
|
----
|
|
/filter add joinquit * irc_join,irc_part,irc_quit *
|
|
----
|
|
|
|
[NOTE]
|
|
For help: `/help filter`, `/help irc.look.smart_filter` and see
|
|
link:weechat_user.en.html#irc_smart_filter_join_part_quit[User's guide / Smart filter for join/part/quit messages].
|
|
|
|
[[filter_irc_join_channel_messages]]
|
|
=== How can I filter some messages displayed when I join an IRC channel?
|
|
|
|
With WeeChat ≥ 0.4.1, you can choose which messages are displayed when
|
|
joining a channel with the option _irc.look.display_join_message_ (see
|
|
`/help irc.look.display_join_message` for more info).
|
|
|
|
To hide messages (but keep them in buffer), you can filter them using the tag
|
|
(for example _irc_329_ for channel creation date). See `/help filter` for help
|
|
with filters.
|
|
|
|
[[filter_voice_messages]]
|
|
=== How can I filter voice messages (eg on Bitlbee server)?
|
|
|
|
It's not easy to filter voice messages, because voice mode can be set with other
|
|
modes in same IRC message.
|
|
|
|
If you want to do that, it's probably because Bitlbee is using voice to show
|
|
away users, and you are flooded with voice messages. Therefore, you can change
|
|
that and let WeeChat use a special color for away nicks in nicklist.
|
|
|
|
For Bitlbee ≥ 3, issue this on control channel _&bitlbee_:
|
|
|
|
----
|
|
channel set show_users online,away
|
|
----
|
|
|
|
For older version of Bitlbee, issue this on control channel _&bitlbee_:
|
|
|
|
----
|
|
set away_devoice false
|
|
----
|
|
|
|
For checking away nicks in WeeChat, see question about
|
|
<<color_away_nicks,away nicks>>.
|
|
|
|
If you really want to filter voice messages, you can use this command, but this
|
|
is not perfect (will work only if first mode changed is voice):
|
|
|
|
----
|
|
/filter add hidevoices * irc_mode (\+|\-)v
|
|
----
|
|
|
|
[[color_away_nicks]]
|
|
=== How can I see away nicks in nicklist?
|
|
|
|
You have to set option _irc.server_default.away_check_ to a positive value
|
|
(minutes between each check of away nicks).
|
|
|
|
You can set option _irc.server_default.away_check_max_nicks_ to limit away check
|
|
on small channels only.
|
|
|
|
For example, check every 5 minutes for away nicks, for channels with max 25
|
|
nicks:
|
|
|
|
----
|
|
/set irc.server_default.away_check 5
|
|
/set irc.server_default.away_check_max_nicks 25
|
|
----
|
|
|
|
[NOTE]
|
|
For WeeChat ≤ 0.3.3, options are _irc.network.away_check_ and
|
|
_irc.network.away_check_max_nicks_.
|
|
|
|
[[highlight_notification]]
|
|
=== How can I be warned when someone highlights me on a channel?
|
|
|
|
With WeeChat ≥ 1.0, there is a default trigger "beep" which sends a _BEL_ to
|
|
the terminal on a highlight or private message. Thus you can configure your
|
|
terminal (or multiplexer like screen/tmux) to run a command or play a sound
|
|
when a _BEL_ occurs.
|
|
|
|
Or you can add a command in "beep" trigger:
|
|
|
|
----
|
|
/set trigger.trigger.beep.command "/print -beep;/exec -bg /path/to/command arguments"
|
|
----
|
|
|
|
With an older WeeChat, you can use a script like _beep.pl_ or _launcher.pl_.
|
|
|
|
For _launcher.pl_, you have to setup a command:
|
|
|
|
----
|
|
/set plugins.var.perl.launcher.signal.weechat_highlight "/path/to/command arguments"
|
|
----
|
|
|
|
Other scripts on this subject:
|
|
|
|
----
|
|
/script search notify
|
|
----
|
|
|
|
[[disable_highlights_for_specific_nicks]]
|
|
=== How can I disable highlights for specific nicks?
|
|
|
|
With WeeChat ≥ 0.3.4 you can use the
|
|
link:weechat_user.en.html#max_hotlist_level_nicks[hotlist_max_level_nicks_add]
|
|
buffer property to set the max hotlist level for some nicks, per buffer,
|
|
or per group of buffers (like IRC servers).
|
|
|
|
To only disable highlights, you'd have to set it to 2:
|
|
|
|
----
|
|
/buffer set hotlist_max_level_nicks_add joe:2,mike:2
|
|
----
|
|
|
|
This buffer property isn't stored in the configuration though.
|
|
To automatically reapply these buffer properties, you would need the
|
|
_buffer_autoset.py_ script:
|
|
|
|
----
|
|
/script install buffer_autoset.py
|
|
----
|
|
|
|
For example, to permanently disable highlights from "mike" on #weechat
|
|
on the IRC server freenode:
|
|
|
|
----
|
|
/buffer_autoset add irc.freenode.#weechat hotlist_max_level_nicks_add mike:2
|
|
----
|
|
|
|
To apply it to the entire freenode server instead:
|
|
|
|
----
|
|
/buffer_autoset add irc.freenode hotlist_max_level_nicks_add mike:2
|
|
----
|
|
|
|
For more examples, see `/help buffer_autoset`.
|
|
|
|
[[irc_target_buffer]]
|
|
=== How can I change target buffer for commands on merged buffers (like buffer with servers)?
|
|
|
|
The default key is kbd:[Ctrl+x] (command is: `/input switch_active_buffer`).
|
|
|
|
[[plugins_scripts]]
|
|
== Plugins / scripts
|
|
|
|
[[openbsd_plugins]]
|
|
=== I'm using OpenBSD and WeeChat does not load any plugins, what's wrong?
|
|
|
|
Under OpenBSD, plugin filenames end with ".so.0.0" (".so" for Linux).
|
|
|
|
You must set that up:
|
|
|
|
----
|
|
/set weechat.plugin.extension ".so.0.0"
|
|
/plugin autoload
|
|
----
|
|
|
|
[[install_scripts]]
|
|
=== How can I install scripts? Are scripts compatible with other IRC clients?
|
|
|
|
With WeeChat ≥ 0.3.9 you can use the command `/script` to install and manage scripts
|
|
(see `/help script` for help). For older versions there is weeget.py and script.pl.
|
|
|
|
Scripts are not compatible with other IRC clients.
|
|
|
|
[[scripts_update]]
|
|
=== The command "/script update" can not read scripts, how to fix that?
|
|
|
|
First check questions about SSL connection in this FAQ
|
|
(especially the option _weechat.network.gnutls_ca_file_).
|
|
|
|
If still not working, try to manually delete the scripts file (in your shell):
|
|
|
|
----
|
|
$ rm ~/.weechat/script/plugins.xml.gz
|
|
----
|
|
|
|
And update scripts again in WeeChat:
|
|
|
|
----
|
|
/script update
|
|
----
|
|
|
|
If you still have an error, then you must disable the automatic update of file
|
|
in WeeChat and download the file manually outside WeeChat (that means you'll
|
|
have to update manually the file yourself to get updates):
|
|
|
|
* in WeeChat:
|
|
|
|
----
|
|
/set script.scripts.cache_expire -1
|
|
----
|
|
|
|
* in your shell, with curl installed:
|
|
|
|
----
|
|
$ cd ~/.weechat/script
|
|
$ curl -O https://weechat.org/files/plugins.xml.gz
|
|
----
|
|
|
|
[[spell_dictionaries]]
|
|
=== I installed aspell dictionaries on my system, how can I use them without restarting WeeChat?
|
|
|
|
You have to reload the spell plugin:
|
|
|
|
----
|
|
/plugin reload spell
|
|
----
|
|
|
|
[NOTE]
|
|
With WeeChat ≤ 2.3, the "spell" plugin was named "aspell", so the command is:
|
|
`/plugin reload aspell`.
|
|
|
|
[[settings]]
|
|
== Settings
|
|
|
|
[[editing_config_files]]
|
|
=== Can I edit configuration files (*.conf) by hand?
|
|
|
|
You can, but this is *NOT* recommended.
|
|
|
|
Command `/set` in WeeChat is recommended:
|
|
|
|
* You can complete the name and value of option with kbd:[Tab] key
|
|
(or kbd:[Shift+Tab] for partial completion, useful for the name).
|
|
* The value is checked, a message is displayed in case of error.
|
|
* The value is used immediately, you don't need to restart anything.
|
|
|
|
If you still want to edit files by hand, you should be careful:
|
|
|
|
* If you put an invalid value for an option, WeeChat will display an error
|
|
on load and discard the value (the default value for option will be used).
|
|
* If WeeChat is running, you'll have to issue the command `/reload`, and if
|
|
some settings were changed but not saved with `/save`, you will lose them.
|
|
|
|
[[memory_usage]]
|
|
=== How can I tweak WeeChat to consume less memory?
|
|
|
|
You can try following tips to consume less memory:
|
|
|
|
* Use the latest stable version (it is supposed to have less memory leaks than
|
|
older versions).
|
|
* Do not load some plugins if you don't use them, for example: buflist,
|
|
fifo, logger, perl, python, ruby, lua, tcl, guile, javascript, php, spell,
|
|
xfer (used for DCC). See `/help weechat.plugin.autoload`.
|
|
* Load only scripts that you really need.
|
|
* Do not load certificates if SSL is *NOT* used: set empty string in option
|
|
_weechat.network.gnutls_ca_file_.
|
|
* Reduce value of option _weechat.history.max_buffer_lines_number_ or set value
|
|
of option _weechat.history.max_buffer_lines_minutes_.
|
|
* Reduce value of option _weechat.history.max_commands_.
|
|
|
|
[[cpu_usage]]
|
|
=== How can I tweak WeeChat to use less CPU?
|
|
|
|
You can follow same tips as for <<memory_usage,memory>>, and these ones:
|
|
|
|
* Hide "nicklist" bar: `/bar hide nicklist`.
|
|
* Remove display of seconds in status bar time:
|
|
`/set weechat.look.item_time_format "%H:%M"` (this is the default value).
|
|
* Disable real time check of misspelled words in command line (if you enabled it):
|
|
`/set spell.check.real_time off`.
|
|
* Set the _TZ_ variable (for example: `export TZ="Europe/Paris"`), to prevent
|
|
frequent access to file _/etc/localtime_.
|
|
|
|
[[security]]
|
|
=== I am paranoid about security, which settings could I change to be even more secure?
|
|
|
|
Disable IRC part and quit messages:
|
|
|
|
----
|
|
/set irc.server_default.msg_part ""
|
|
/set irc.server_default.msg_quit ""
|
|
----
|
|
|
|
Disable answers to all CTCP queries:
|
|
|
|
----
|
|
/set irc.ctcp.clientinfo ""
|
|
/set irc.ctcp.finger ""
|
|
/set irc.ctcp.source ""
|
|
/set irc.ctcp.time ""
|
|
/set irc.ctcp.userinfo ""
|
|
/set irc.ctcp.version ""
|
|
/set irc.ctcp.ping ""
|
|
----
|
|
|
|
Unload and disable auto-loading of "xfer" plugin (used for IRC DCC):
|
|
|
|
----
|
|
/plugin unload xfer
|
|
/set weechat.plugin.autoload "*,!xfer"
|
|
----
|
|
|
|
Define a passphrase and use secured data wherever you can for sensitive data
|
|
like passwords: see `/help secure` and `/help` on options
|
|
(if you can use secured data, it is written in the help).
|
|
See also link:weechat_user.en.html#secured_data[User's guide / Secured data].
|
|
|
|
For example:
|
|
|
|
----
|
|
/secure passphrase xxxxxxxxxx
|
|
/secure set freenode_username username
|
|
/secure set freenode_password xxxxxxxx
|
|
/set irc.server.freenode.sasl_username "${sec.data.freenode_username}"
|
|
/set irc.server.freenode.sasl_password "${sec.data.freenode_password}"
|
|
----
|
|
|
|
[[sharing_config_files]]
|
|
=== I want to share my WeeChat configuration, what files should I share and what should I keep private?
|
|
|
|
You can share files _~/.weechat/*.conf_ except the file _sec.conf_ which
|
|
contains your passwords ciphered with your passphrase.
|
|
|
|
Some other files like _irc.conf_ may contain sensitive info like passwords
|
|
for servers/channels (if they are not stored in _sec.conf_ with the `/secure`
|
|
command).
|
|
|
|
See the link:weechat_user.en.html#files_and_directories[User's guide / Files and directories]
|
|
for more information about configuration files.
|
|
|
|
[[development]]
|
|
== Development
|
|
|
|
[[bug_task_patch]]
|
|
=== How should I report bugs, ask for new features or send patches?
|
|
|
|
See: https://weechat.org/about/support
|
|
|
|
[[gdb_error_threads]]
|
|
=== When I run WeeChat under gdb, there is an error about threads, what can I do?
|
|
|
|
When you run WeeChat under gdb, you may have this error:
|
|
|
|
----
|
|
$ gdb /path/to/weechat
|
|
(gdb) run
|
|
[Thread debugging using libthread_db enabled]
|
|
Cannot find new threads: generic error
|
|
----
|
|
|
|
To fix that, you can run gdb with this command (replace path to libpthread and
|
|
WeeChat with paths on your system):
|
|
|
|
----
|
|
$ LD_PRELOAD=/lib/libpthread.so.0 gdb /path/to/weechat
|
|
(gdb) run
|
|
----
|
|
|
|
[[supported_os]]
|
|
=== What is the list of supported platforms for WeeChat? Will it be ported to other operating systems?
|
|
|
|
The full list is on this page: https://weechat.org/download
|
|
|
|
We do our best to run on as many platforms as possible. Help is welcome for
|
|
some OS' we don't have, to test WeeChat.
|
|
|
|
[[help_developers]]
|
|
=== I want to help WeeChat developers. What can I do?
|
|
|
|
There are many tasks to do (testing, code, documentation, etc.)
|
|
|
|
Please contact us via IRC or mail, look at support page:
|
|
https://weechat.org/about/support
|
|
|
|
[[donate]]
|
|
=== Can I give money or other things to WeeChat developers?
|
|
|
|
You can give us money to help development.
|
|
Details on https://weechat.org/donate
|