'\" t
.\"     Title: weechat
.\"    Author: Sébastien Helleu
.\" Generator: Asciidoctor 1.5.4
.\"    Manual: WeeChat Manual
.\"    Source: WeeChat 1.6
.\"  Language: English
.\"
.TH "WEECHAT" "1" "" "WeeChat 1.6" "WeeChat Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.LINKSTYLE blue R < >
.SH "NAME"
weechat \- the extensible chat client
.SH "SYNOPSIS"
.sp
.nf
\fBweechat\fP [\-a|\-\-no\-connect] [\-d|\-\-dir <path>] [\-p|\-\-no\-plugin] [\-r|\-\-run\-command <command>] [\-s|\-\-no\-script] [\-\-upgrade] [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\-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\-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\-r\fP, \fB\-\-run\-command\fP \fI<command>\fP
.RS 4
Run command(s) after startup (many commands can be separated by semicolons).
.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 "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/aspell.conf
.RS 4
configuration file for \fIaspell\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/irc.conf
.RS 4
configuration file for \fIirc\fP plugin
.RE
.sp
$HOME/.weechat/logger.conf
.RS 4
configuration file for \fIlogger\fP plugin
.RE
.sp
$HOME/.weechat/relay.conf
.RS 4
configuration file for \fIrelay\fP plugin
.RE
.sp
$HOME/.weechat/script.conf
.RS 4
configuration file for \fIscript\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 "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\-2016 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/dev/support" "" ""
.SH "AUTHOR(S)"
.sp
\fBSébastien Helleu\fP
.RS 4
Author(s).
.RE