1WEECHAT(1) WeeChat Manual WEECHAT(1)
2
6 weechat - the extensible chat client
7
9 weechat [-a|--no-connect] [-d|--dir <path>] [-t|--temp-dir] [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [debug-option...] [plugin:option...]
10 weechat [-c|--colors]
11 weechat [-h|--help]
12 weechat [-l|--license]
13 weechat [-v|--version]
14
16 WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast
17 and light, designed for many operating systems. It is highly
18 customizable and extensible with scripts.
19
21 -a, --no-connect
22 Disable auto-connect to servers when WeeChat is starting.
23 -c, --colors
25 Display default colors in terminal.
26 --daemon
28 Run WeeChat in background, as a daemon (works only with the command
29 weechat-headless).
30 --stdout
32 Display log messages on standard output instead of writing them in
33 log file (works only with the command weechat-headless, not
34 compatible with option "--daemon").
35 -d, --dir <path>
37 Set path as home for WeeChat (used for configuration files, logs,
38 user plugins and scripts), default value is "~/.weechat" (note:
39 directory is created if not found by WeeChat). If this option is
40 not given, the environment variable WEECHAT_HOME is used (if not
41 empty).
42 -t, --temp-dir
44 Create a temporary WeeChat home directory and delete it on exit
45 (incompatible with option "-d").
46 The name of the directory is automatically built by WeeChat, with
47 this template: "weechat_temp_XXXXXX" (where "XXXXXX" is random). It
48 it created in the first available directory in this list:
49 environment variable "TMPDIR", "/tmp" (may be different according
50 to the operating system), environment variable "HOME", current
51 directory.
52 The temporary home directory has permissions 0700 (only owner can
53 read, write and execute).
54 -h, --help
56 Display help.
57 -l, --license
59 Display WeeChat license.
60 -p, --no-plugin
62 Disable plugins auto-load.
63 -P, --plugins <plugins>
65 Load only these plugins at startup (see /help
66 weechat.plugin.autoload). If this option is given, the option
67 weechat.plugin.autoload is not used.
68 -r, --run-command <command>
70 Run command(s) after startup; many commands can be separated by
71 semicolons, this option can be given multiple times.
72 -s, --no-script
74 Disable scripts auto-load.
75 --upgrade
77 Upgrade WeeChat using session files generated with command /upgrade
78 -quit.
79 -v, --version
81 Display WeeChat version.
82 plugin:option
84 Option for a plugin.
85
87 WARNING: these options are for debug purposes only, DO NOT USE IN
88 PRODUCTION!
89 --no-dlclose
91 Do not call the function dlclose after plugins are unloaded. This
92 is useful with tools like Valgrind to display stack for unloaded
93 plugins.
94 --no-gnutls
96 Do not call the init and deinit functions of GnuTLS library. This
97 is useful with tools like Valgrind and electric-fence, to prevent
98 GnuTLS memory errors.
99 --no-gcrypt
101 Do not call the init and deinit functions of Gcrypt library. This
102 is useful with tools like Valgrind, to prevent Gcrypt memory
103 errors.
104
106 For complete doc on plugin options, please look at plugins
107 documentation in WeeChat user’s guide <https://weechat.org/doc>.
108 With irc plugin, you can connect to temporary server with an URL like:
110 irc[6][s]://[[nickname][:password]@]server[:port][/#channel1[,#channel2...]]
112 To join WeeChat IRC channel support with nick "mynick":
114 irc://mynick@chat.freenode.net/#weechat
116 IPv6 address can be enclosed in brackets to add a port after address,
118 for example:
119 irc://mynick@[2001:db8:0:85a3::ac1f:8001]:6668/#test
121
123 $HOME/.weechat/weechat.conf
124 main WeeChat configuration file
125 $HOME/.weechat/plugins.conf
127 plugins configuration file
128 $HOME/.weechat/sec.conf
130 configuration file with secured data
131 $HOME/.weechat/alias.conf
133 configuration file for alias plugin
134 $HOME/.weechat/buflist.conf
136 configuration file for buflist plugin
137 $HOME/.weechat/charset.conf
139 configuration file for charset plugin
140 $HOME/.weechat/exec.conf
142 configuration file for exec plugin
143 $HOME/.weechat/fifo.conf
145 configuration file for fifo plugin
146 $HOME/.weechat/fset.conf
148 configuration file for fset plugin
149 $HOME/.weechat/guile.conf
151 configuration file for guile plugin
152 $HOME/.weechat/irc.conf
154 configuration file for irc plugin
155 $HOME/.weechat/javascript.conf
157 configuration file for javascript plugin
158 $HOME/.weechat/logger.conf
160 configuration file for logger plugin
161 $HOME/.weechat/lua.conf
163 configuration file for lua plugin
164 $HOME/.weechat/perl.conf
166 configuration file for perl plugin
167 $HOME/.weechat/php.conf
169 configuration file for php plugin
170 $HOME/.weechat/python.conf
172 configuration file for python plugin
173 $HOME/.weechat/relay.conf
175 configuration file for relay plugin
176 $HOME/.weechat/ruby.conf
178 configuration file for ruby plugin
179 $HOME/.weechat/script.conf
181 configuration file for script plugin
182 $HOME/.weechat/spell.conf
184 configuration file for spell plugin
185 $HOME/.weechat/tcl.conf
187 configuration file for tcl plugin
188 $HOME/.weechat/trigger.conf
190 configuration file for trigger plugin
191 $HOME/.weechat/xfer.conf
193 configuration file for xfer plugin
194 $HOME/.weechat/weechat.log
196 WeeChat log file
197
199 weechat-headless(1)
200
202 This manpage was written by Sébastien Helleu.
203
205 WeeChat is written by Sébastien Helleu and contributors (complete list
206 is in the AUTHORS.adoc file).
207 Copyright © 2003-2020 Sébastien Helleu
209 WeeChat is free software; you can redistribute it and/or modify it
211 under the terms of the GNU General Public License as published by the
212 Free Software Foundation; either version 3 of the License, or (at your
213 option) any later version.
214 Please read the COPYING file for more information.
216 Web: https://weechat.org/
218
220 For help or a bug report: https://weechat.org/about/support
221
223 Sébastien Helleu
224WeeChat 3.0.1 2021-02-12 WEECHAT(1)