Weechat
Basic command and uses for Weechat
Adding and Connecting to a Server
To add a server (in this case the OFTC network), you will use the /server command.
/server add oftc irc.oftc.net/6697 -ssl -autoconnect
This adds a server named “oftc” with hostname “irc.oftc.net” connecting on port 6697. WeeChat will connect using SSL and will automatically connect when you start WeeChat. Once you define the server, you can run:
/connect oftc
This will tell WeeChat to connect to the server you just set up.
To disconnect, run:
/disconnect oftc
Joining and Parting Channels
To join a channel, run:
/join channel
For example, /join #linode.
Make sure to run join/part commands in the proper server window. You can use ALT+X to switch server windows.
To part, or leave, a channel, run:
/part channel
For example, /part #linode.
Switching Channels/Buffers
If you have mouse support enabled and also have installed buffers.pl (see the WeeChat Commands section below), then you can simply click on buffers you have joined then type messages in the bottom bar. Pressing Enter will submit your message.
Otherwise, you can use /buffer to switch between buffers by number or name. For example, /buffer 1 will switch to buffer 1, while /buffer #linode will switch to the #linode buffer. You can also press ALT+number (ESC+number on a Mac), where “number” is 1-9, to switch to that buffer number. ALT+4 (ESC+4 on a Mac) will switch to buffer 4.
Sending Private Messages
To send a private message to a nickname, run:
/msg nick message
For example, to send the message “Have you heard about Linode?” to someone with the nickname friend, run:
/msg friend Have you heard about Linode?
You can also open a buffer for a nickname with /query. This will create a new buffer which you can send and receive messages in to and from a user. For example, /query friend will open a conversation with “friend”.
Changing your Nickname
To change your nickname after you have connected, run:
/nick newnickname
Note that this will only work if the new nickname is not already in use.
Quitting WeeChat
To quit WeeChat completely, run:
/quit
Configuring WeeChat
You usually will not have to directly edit any WeeChat configuration files. Most configuration is done through WeeChat commands.
Installing Plugins
WeeChat has a plugins system which allows you to install different modifications to WeeChat for different use-cases and user preference. In WeeChat versions 0.3.9 and above, a script management system is included. /script will open up a list of available and installed scripts. From there, you can follow the instructions to install scripts interactively, or install a script using /script install followed by the script name.
WeeChat Commands
All WeeChat commands begin with a /. Every channel in WeeChat is a buffer. Servers are also buffers. By default, WeeChat does not include a list of buffers, but you may install a plugin that does. The buffers.pl plugin is recommended and displays a list of buffers on the left of the screen. This allows you to see what channels and servers you are in without having to remember special commands.
/script install buffers.pl
/mouse enable will enable mouse support, which allows you to scroll as well as click buffers to change channels and servers.
A list of basic commands is below.
| Command | Description |
|---|---|
/help
|
Lists commands, if a command is given then shows command usage and description |
/join
|
Joins a channel |
/close
|
Closes a buffer, parting the channel if you are in it |
/quit
|
Quit WeeChat |
/msg
|
Send a message to a nick (or channel) |
/query
|
Opens a private buffer with a nick |
/ban
|
Ban a user from a channel |
/unban
|
Unban a user from a channel |
/kick
|
Kick a user from a channel |
/kickban
|
Kick and ban a user from a channel |
/part
|
Parts a channel but does not close the buffers |
/topic
|
Sets channel topic |
/whois
|
Shows information about a user |
Setting Default Channels
WeeChat uses the /set command to manipulate WeeChat settings. It allows you to change many different attributes about WeeChat, including appearance and functionality.
You can tell WeeChat to automatically connect to some channels when it connects to a server using the irc.server.name.autojoin setting substituting the server to which you are connected for name. In the above configuration, we connected to oftc. This setting should be a comma separated list of channels to join. For example, if I want to join #linode when I connect to the oftc network, I would run:
/set irc.server.oftc.autojoin "#linode"
Then, whenever I connect to the oftc server, I will automatically join #linode.
Setting Default Nickname, Username, and Real Name
Setting the default nickname, username, and real name is just as simple. To set your default nickname, run:
/set irc.server_default.nicks "nickname"
You can also specify backup nicknames in case the one you want is taken when you connect.
/set irc.server_default.nicks "nickname,othernickname"
Setting the default username:
/set irc.server_default.username "username"
Setting the default real name:
/set irc.server_default.realname "realname"
More info: