weechat-headless(1)

1WEECHAT-HEADLESS(1)             WeeChat Manual             WEECHAT-HEADLESS(1)
2
3
4

NAME

6       weechat-headless - the extensible chat client (headless version)
7

SYNOPSIS

9       weechat-headless [-a|--no-connect] [--daemon] [--stdout] [-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-headless [-c|--colors]
11       weechat-headless [-h|--help]
12       weechat-headless [-l|--license]
13       weechat-headless [-v|--version]
14

DESCRIPTION

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
20       The command weechat-headless runs WeeChat in a headless mode (no
21       interface). It can be used for tests or to daemonize WeeChat with the
22       option "--daemon".
23

OPTIONS

25       -a, --no-connect
26           Disable auto-connect to servers when WeeChat is starting.
27
28       -c, --colors
29           Display default colors in terminal.
30
31       --daemon
32           Run WeeChat in background, as a daemon (works only with the command
33           weechat-headless).
34
35       --stdout
36           Display log messages on standard output instead of writing them in
37           log file (works only with the command weechat-headless, not
38           compatible with option "--daemon").
39
40       -d, --dir <path>
41           Set path as home for WeeChat (used for configuration files, logs,
42           user plugins and scripts), default value is "~/.weechat" (note:
43           directory is created if not found by WeeChat). If this option is
44           not given, the environment variable WEECHAT_HOME is used (if not
45           empty).
46
47       -t, --temp-dir
48           Create a temporary WeeChat home directory and delete it on exit
49           (incompatible with option "-d").
50           The name of the directory is automatically built by WeeChat, with
51           this template: "weechat_temp_XXXXXX" (where "XXXXXX" is random). It
52           it created in the first available directory in this list:
53           environment variable "TMPDIR", "/tmp" (may be different according
54           to the operating system), environment variable "HOME", current
55           directory.
56           The temporary home directory has permissions 0700 (only owner can
57           read, write and execute).
58
59       -h, --help
60           Display help.
61
62       -l, --license
63           Display WeeChat license.
64
65       -p, --no-plugin
66           Disable plugins auto-load.
67
68       -P, --plugins <plugins>
69           Load only these plugins at startup (see /help
70           weechat.plugin.autoload). If this option is given, the option
71           weechat.plugin.autoload is not used.
72
73       -r, --run-command <command>
74           Run command(s) after startup; many commands can be separated by
75           semicolons, this option can be given multiple times.
76
77       -s, --no-script
78           Disable scripts auto-load.
79
80       --upgrade
81           Upgrade WeeChat using session files generated with command /upgrade
82           -quit.
83
84       -v, --version
85           Display WeeChat version.
86
87       plugin:option
88           Option for a plugin.
89

DEBUG OPTIONS

91       WARNING: these options are for debug purposes only, DO NOT USE IN
92       PRODUCTION!
93
94       --no-dlclose
95           Do not call the function dlclose after plugins are unloaded. This
96           is useful with tools like Valgrind to display stack for unloaded
97           plugins.
98
99       --no-gnutls
100           Do not call the init and deinit functions of GnuTLS library. This
101           is useful with tools like Valgrind and electric-fence, to prevent
102           GnuTLS memory errors.
103
104       --no-gcrypt
105           Do not call the init and deinit functions of Gcrypt library. This
106           is useful with tools like Valgrind, to prevent Gcrypt memory
107           errors.
108

PLUGIN OPTIONS

110       For complete doc on plugin options, please look at plugins
111       documentation in WeeChat user’s guide <https://weechat.org/doc>.
112
113       With irc plugin, you can connect to temporary server with an URL like:
114
115           irc[6][s]://[[nickname][:password]@]server[:port][/#channel1[,#channel2...]]
116
117       To join WeeChat IRC channel support with nick "mynick":
118
119           irc://mynick@chat.freenode.net/#weechat
120
121       IPv6 address can be enclosed in brackets to add a port after address,
122       for example:
123
124           irc://mynick@[2001:db8:0:85a3::ac1f:8001]:6668/#test
125

FILES

127       $HOME/.weechat/weechat.conf
128           main WeeChat configuration file
129
130       $HOME/.weechat/plugins.conf
131           plugins configuration file
132
133       $HOME/.weechat/sec.conf
134           configuration file with secured data
135
136       $HOME/.weechat/alias.conf
137           configuration file for alias plugin
138
139       $HOME/.weechat/buflist.conf
140           configuration file for buflist plugin
141
142       $HOME/.weechat/charset.conf
143           configuration file for charset plugin
144
145       $HOME/.weechat/exec.conf
146           configuration file for exec plugin
147
148       $HOME/.weechat/fifo.conf
149           configuration file for fifo plugin
150
151       $HOME/.weechat/fset.conf
152           configuration file for fset plugin
153
154       $HOME/.weechat/guile.conf
155           configuration file for guile plugin
156
157       $HOME/.weechat/irc.conf
158           configuration file for irc plugin
159
160       $HOME/.weechat/javascript.conf
161           configuration file for javascript plugin
162
163       $HOME/.weechat/logger.conf
164           configuration file for logger plugin
165
166       $HOME/.weechat/lua.conf
167           configuration file for lua plugin
168
169       $HOME/.weechat/perl.conf
170           configuration file for perl plugin
171
172       $HOME/.weechat/php.conf
173           configuration file for php plugin
174
175       $HOME/.weechat/python.conf
176           configuration file for python plugin
177
178       $HOME/.weechat/relay.conf
179           configuration file for relay plugin
180
181       $HOME/.weechat/ruby.conf
182           configuration file for ruby plugin
183
184       $HOME/.weechat/script.conf
185           configuration file for script plugin
186
187       $HOME/.weechat/spell.conf
188           configuration file for spell plugin
189
190       $HOME/.weechat/tcl.conf
191           configuration file for tcl plugin
192
193       $HOME/.weechat/trigger.conf
194           configuration file for trigger plugin
195
196       $HOME/.weechat/xfer.conf
197           configuration file for xfer plugin
198
199       $HOME/.weechat/weechat.log
200           WeeChat log file
201

AUTHORS

206       This manpage was written by Sébastien Helleu.
207

COPYRIGHT

209       WeeChat is written by Sébastien Helleu and contributors (complete list
210       is in the AUTHORS.adoc file).
211
212       Copyright © 2003-2020 Sébastien Helleu
213
214       WeeChat is free software; you can redistribute it and/or modify it
215       under the terms of the GNU General Public License as published by the
216       Free Software Foundation; either version 3 of the License, or (at your
217       option) any later version.
218
219       Please read the COPYING file for more information.
220
221       Web: https://weechat.org/
222

SUPPORT / REPORTING BUGS

224       For help or a bug report: https://weechat.org/about/support
225

AUTHOR

227       Sébastien Helleu
228
229
230
231WeeChat 3.0.1                     2021-02-12               WEECHAT-HEADLESS(1)