Arch manual pages

WEECHAT(1) WeeChat Manual WEECHAT(1)

weechat - the extensible chat client

weechat [-a|--no-connect] [-d|--dir <path>] [-t|--temp-dir] [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
weechat [-c|--colors]
weechat [-h|--help]
weechat [-l|--license]
weechat [-v|--version]

WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and light, designed for many operating systems. It is highly customizable and extensible with scripts.

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

-d, --dir <path>

Set path as home for WeeChat (used for configuration files, logs, user plugins and scripts), default value is "~/.weechat" (note: directory is created if not found by WeeChat). 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.

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

For complete doc on plugin options, please look at plugins documentation in WeeChat user’s guide <https://weechat.org/doc>.

With irc plugin, you can connect to temporary server with an URL like:

irc[6][s]://[[nickname][:password]@]server[:port][/#channel1[,#channel2...]]

To join WeeChat IRC channel support with nick "mynick":

irc://mynick@chat.freenode.net/#weechat

IPv6 address can be enclosed in brackets to add a port after address, for example:

irc://mynick@[2001:db8:0:85a3::ac1f:8001]:6668/#test

$HOME/.weechat/weechat.conf
main WeeChat configuration file

$HOME/.weechat/plugins.conf

plugins configuration file

$HOME/.weechat/sec.conf

configuration file with secured data

$HOME/.weechat/alias.conf

configuration file for alias plugin

$HOME/.weechat/aspell.conf

configuration file for aspell plugin

$HOME/.weechat/buflist.conf

configuration file for buflist plugin

$HOME/.weechat/charset.conf

configuration file for charset plugin

$HOME/.weechat/exec.conf

configuration file for exec plugin

$HOME/.weechat/fifo.conf

configuration file for fifo plugin

$HOME/.weechat/fset.conf

configuration file for fset plugin

$HOME/.weechat/guile.conf

configuration file for guile plugin

$HOME/.weechat/irc.conf

configuration file for irc plugin

$HOME/.weechat/javascript.conf

configuration file for javascript plugin

$HOME/.weechat/logger.conf

configuration file for logger plugin

$HOME/.weechat/lua.conf

configuration file for lua plugin

$HOME/.weechat/perl.conf

configuration file for perl plugin

$HOME/.weechat/php.conf

configuration file for php plugin

$HOME/.weechat/python.conf

configuration file for python plugin

$HOME/.weechat/relay.conf

configuration file for relay plugin

$HOME/.weechat/ruby.conf

configuration file for ruby plugin

$HOME/.weechat/script.conf

configuration file for script plugin

$HOME/.weechat/tcl.conf

configuration file for tcl plugin

$HOME/.weechat/trigger.conf

configuration file for trigger plugin

$HOME/.weechat/xfer.conf

configuration file for xfer plugin

$HOME/.weechat/weechat.log

WeeChat log file

weechat-headless(1)

This manpage was written by Sébastien Helleu.

WeeChat is written by Sébastien Helleu and contributors (complete list is in the AUTHORS.adoc file).

Copyright © 2003-2019 Sébastien Helleu

WeeChat is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Please read the COPYING file for more information.

Web: <https://weechat.org/>

For help or a bug report: <https://weechat.org/about/support>

Sébastien Helleu
2019-02-19 WeeChat 2.4