'\" t
.\"     Title: weechat
.\"    Author: Sébastien Helleu
.\" Generator: Asciidoctor 1.5.8
.\"    Manual: WeeChat Manual
.\"    Source: WeeChat 2.8
.\"  Language: English
.\"
.TH "WEECHAT" "1" "" "WeeChat 2.8" "WeeChat Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
weechat \- the extensible chat client
.SH "SYNOPSIS"
.sp
.nf
\fBweechat\fP [\-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...]
\fBweechat\fP [\-c|\-\-colors]
\fBweechat\fP [\-h|\-\-help]
\fBweechat\fP [\-l|\-\-license]
\fBweechat\fP [\-v|\-\-version]
.fi
.br
.SH "DESCRIPTION"
.sp
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.
.SH "OPTIONS"
.sp
\fB\-a\fP, \fB\-\-no\-connect\fP
.RS 4
Disable auto\-connect to servers when WeeChat is starting.
.RE
.sp
\fB\-c\fP, \fB\-\-colors\fP
.RS 4
Display default colors in terminal.
.RE
.sp
\fB\-\-daemon\fP
.RS 4
Run WeeChat in background, as a daemon (works only with the command
\fBweechat\-headless\fP).
.RE
.sp
\fB\-d\fP, \fB\-\-dir\fP \fI<path>\fP
.RS 4
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).
.RE
.sp
\fB\-t\fP, \fB\-\-temp\-dir\fP
.RS 4
Create a temporary WeeChat home directory and delete it on exit
(incompatible with option "\-d").
.br
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.
.br
The temporary home directory has permissions 0700 (only owner can read,
write and execute).
.RE
.sp
\fB\-h\fP, \fB\-\-help\fP
.RS 4
Display help.
.RE
.sp
\fB\-l\fP, \fB\-\-license\fP
.RS 4
Display WeeChat license.
.RE
.sp
\fB\-p\fP, \fB\-\-no\-plugin\fP
.RS 4
Disable plugins auto\-load.
.RE
.sp
\fB\-P\fP, \fB\-\-plugins\fP \fI<plugins>\fP
.RS 4
Load only these plugins at startup (see /help weechat.plugin.autoload).
If this option is given, the option weechat.plugin.autoload is not used.
.RE
.sp
\fB\-r\fP, \fB\-\-run\-command\fP \fI<command>\fP
.RS 4
Run command(s) after startup; many commands can be separated by semicolons,
this option can be given multiple times.
.RE
.sp
\fB\-s\fP, \fB\-\-no\-script\fP
.RS 4
Disable scripts auto\-load.
.RE
.sp
\fB\-\-upgrade\fP
.RS 4
Upgrade WeeChat using session files generated with command \f(CR/upgrade \-quit\fP.
.RE
.sp
\fB\-v\fP, \fB\-\-version\fP
.RS 4
Display WeeChat version.
.RE
.sp
\fBplugin:option\fP
.RS 4
Option for a plugin.
.RE
.SH "DEBUG OPTIONS"
.sp
\fBWARNING:\fP these options are for debug purposes only, \fBDO NOT USE IN PRODUCTION!\fP
.sp
\fB\-\-no\-dlclose\fP
.RS 4
Do not call the function dlclose after plugins are unloaded.
This is useful with tools like Valgrind to display stack for unloaded
plugins.
.RE
.sp
\fB\-\-no\-gnutls\fP
.RS 4
Do not call the init and deinit functions of GnuTLS library.
This is useful with tools like Valgrind and electric\-fence, to prevent
GnuTLS memory errors.
.RE
.sp
\fB\-\-no\-gcrypt\fP
.RS 4
Do not call the init and deinit functions of Gcrypt library.
This is useful with tools like Valgrind, to prevent Gcrypt memory errors.
.RE
.SH "PLUGIN OPTIONS"
.sp
For complete doc on plugin options, please look at plugins documentation in
.URL "https://weechat.org/doc" "WeeChat user\(cqs guide" "."
.sp
With irc plugin, you can connect to temporary server with an URL like:
.sp
.if n .RS 4
.nf
irc[6][s]://[[nickname][:password]@]server[:port][/#channel1[,#channel2...]]
.fi
.if n .RE
.sp
To join WeeChat IRC channel support with nick "mynick":
.sp
.if n .RS 4
.nf
irc://mynick@chat.freenode.net/#weechat
.fi
.if n .RE
.sp
IPv6 address can be enclosed in brackets to add a port after address, for
example:
.sp
.if n .RS 4
.nf
irc://mynick@[2001:db8:0:85a3::ac1f:8001]:6668/#test
.fi
.if n .RE
.SH "FILES"
.sp
$HOME/.weechat/weechat.conf
.RS 4
main WeeChat configuration file
.RE
.sp
$HOME/.weechat/plugins.conf
.RS 4
plugins configuration file
.RE
.sp
$HOME/.weechat/sec.conf
.RS 4
configuration file with secured data
.RE
.sp
$HOME/.weechat/alias.conf
.RS 4
configuration file for \fIalias\fP plugin
.RE
.sp
$HOME/.weechat/buflist.conf
.RS 4
configuration file for \fIbuflist\fP plugin
.RE
.sp
$HOME/.weechat/charset.conf
.RS 4
configuration file for \fIcharset\fP plugin
.RE
.sp
$HOME/.weechat/exec.conf
.RS 4
configuration file for \fIexec\fP plugin
.RE
.sp
$HOME/.weechat/fifo.conf
.RS 4
configuration file for \fIfifo\fP plugin
.RE
.sp
$HOME/.weechat/fset.conf
.RS 4
configuration file for \fIfset\fP plugin
.RE
.sp
$HOME/.weechat/guile.conf
.RS 4
configuration file for \fIguile\fP plugin
.RE
.sp
$HOME/.weechat/irc.conf
.RS 4
configuration file for \fIirc\fP plugin
.RE
.sp
$HOME/.weechat/javascript.conf
.RS 4
configuration file for \fIjavascript\fP plugin
.RE
.sp
$HOME/.weechat/logger.conf
.RS 4
configuration file for \fIlogger\fP plugin
.RE
.sp
$HOME/.weechat/lua.conf
.RS 4
configuration file for \fIlua\fP plugin
.RE
.sp
$HOME/.weechat/perl.conf
.RS 4
configuration file for \fIperl\fP plugin
.RE
.sp
$HOME/.weechat/php.conf
.RS 4
configuration file for \fIphp\fP plugin
.RE
.sp
$HOME/.weechat/python.conf
.RS 4
configuration file for \fIpython\fP plugin
.RE
.sp
$HOME/.weechat/relay.conf
.RS 4
configuration file for \fIrelay\fP plugin
.RE
.sp
$HOME/.weechat/ruby.conf
.RS 4
configuration file for \fIruby\fP plugin
.RE
.sp
$HOME/.weechat/script.conf
.RS 4
configuration file for \fIscript\fP plugin
.RE
.sp
$HOME/.weechat/spell.conf
.RS 4
configuration file for \fIspell\fP plugin
.RE
.sp
$HOME/.weechat/tcl.conf
.RS 4
configuration file for \fItcl\fP plugin
.RE
.sp
$HOME/.weechat/trigger.conf
.RS 4
configuration file for \fItrigger\fP plugin
.RE
.sp
$HOME/.weechat/xfer.conf
.RS 4
configuration file for \fIxfer\fP plugin
.RE
.sp
$HOME/.weechat/weechat.log
.RS 4
WeeChat log file
.RE
.SH "SEE ALSO"
.sp
\fBweechat\-headless\fP(1)
.SH "AUTHORS"
.sp
This manpage was written by Sébastien Helleu.
.SH "COPYRIGHT"
.sp
WeeChat is written by Sébastien Helleu and contributors (complete list is in
the AUTHORS.adoc file).
.sp
Copyright \(co 2003\-2020 Sébastien Helleu
.sp
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.
.sp
Please read the COPYING file for more information.
.sp
Web: \c
.URL "https://weechat.org/" "" ""
.SH "SUPPORT / REPORTING BUGS"
.sp
For help or a bug report: \c
.URL "https://weechat.org/about/support" "" ""
.SH "AUTHOR"
.sp
Sébastien Helleu