2014-03-05 06:44:10 -05:00
:author: Sébastien Helleu
:email: flashcode@flashtux.org
2014-03-06 03:51:07 -05:00
:lang: en
2003-09-27 06:01:11 -04:00
2014-05-04 01:30:22 -04:00
2019-02-24 10:37:19 -05:00
pass:[<p align="center">] image:https://weechat.org/media/images/weechat_logo_large.png[align="center"] pass:[</p>]
2019-02-24 10:14:57 -05:00
2015-11-28 03:05:43 -05:00
image:https://img.shields.io/badge/diaspora*-follow-blue.svg["Diaspora*", link="https://diasp.eu/u/weechat"]
2019-04-04 14:50:49 -04:00
image:https://img.shields.io/badge/mastodon-follow-blue.svg["Mastodon", link="https://hostux.social/@weechat"]
image:https://img.shields.io/badge/twitter-follow-blue.svg["Twitter", link="https://twitter.com/WeeChatClient"]
2019-11-05 01:50:30 -05:00
image:https://img.shields.io/badge/devel%20blog-follow-blue.svg["Devel blog", link="https://blog.weechat.org/"]
2018-11-29 17:18:55 -05:00
image:https://img.shields.io/badge/slant-recommend-28acad.svg["Slant", link="https://www.slant.co/topics/1323/~best-irc-clients-for-linux"]
2018-07-29 05:03:24 -04:00
image:https://img.shields.io/badge/help-donate%20%E2%9D%A4-ff69b4.svg["Donate", link="https://weechat.org/donate/"]
2015-11-28 03:05:43 -05:00
2017-01-15 05:53:31 -05:00
image:https://travis-ci.org/weechat/weechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/weechat"]
2019-03-29 18:17:09 -04:00
image:https://codecov.io/gh/weechat/weechat/branch/master/graph/badge.svg["Code coverage", link="https://codecov.io/gh/weechat/weechat"]
2017-01-15 05:53:31 -05:00
2019-02-24 10:14:57 -05:00
*WeeChat* (Wee Enhanced Environment for Chat) is a free chat client, fast and
2015-04-05 10:01:12 -04:00
light, designed for many operating systems.
It is highly customizable and extensible with scripts.
2003-09-27 06:01:11 -04:00
2014-12-13 03:16:09 -05:00
Homepage: https://weechat.org/
2014-03-05 06:44:10 -05:00
2013-11-06 15:40:46 -05:00
== Features
2009-05-15 17:03:35 -04:00
2018-11-04 16:04:39 -05:00
* *Modular chat client*: WeeChat has a lightweight core and optional https://weechat.org/files/doc/stable/weechat_user.en.html#plugins[plugins]. All plugins (including https://weechat.org/files/doc/stable/weechat_user.en.html#irc_plugin[IRC]) are independent and can be unloaded.
2019-03-21 17:02:31 -04:00
* *Multi-platform*: WeeChat runs on GNU/Linux, *BSD, GNU/Hurd, Haiku, macOS and Windows (Bash/Ubuntu and Cygwin).
2016-12-18 07:39:35 -05:00
* *Multi-protocols*: WeeChat is designed to support multiple protocols by plugins, like IRC.
2018-11-04 16:04:39 -05:00
* *Standards-compliant*: the IRC plugin is compliant with RFCs https://tools.ietf.org/html/rfc1459[1459], https://tools.ietf.org/html/rfc2810[2810], https://tools.ietf.org/html/rfc2811[2811], https://tools.ietf.org/html/rfc2812[2812] and https://tools.ietf.org/html/rfc2813[2813].
2016-12-18 07:39:35 -05:00
* *Small, fast and very light*: the core is and should stay as light and fast as possible.
2018-11-04 16:04:39 -05:00
* *Customizable and extensible*: there are a lot of options to customize WeeChat, and it is extensible with C plugins and https://weechat.org/scripts/[scripts] (https://weechat.org/scripts/stable/language/perl/[Perl], https://weechat.org/scripts/stable/language/python/[Python], https://weechat.org/scripts/stable/language/ruby[Ruby], https://weechat.org/scripts/stable/language/lua/[Lua], https://weechat.org/scripts/stable/language/tcl/[Tcl], https://weechat.org/scripts/stable/language/guile/[Scheme], https://weechat.org/scripts/stable/language/javascript/[JavaScript] and https://weechat.org/scripts/stable/language/php/[PHP]).
* *Fully documented*: there is comprehensive https://weechat.org/doc/[documentation], which is https://weechat.org/files/doc/stable/weechat_dev.en.html#translations[translated] into several languages.
2016-12-18 07:39:35 -05:00
* *Developed from scratch*: WeeChat was built from scratch and is not based on any other client.
2018-11-29 17:16:07 -05:00
* *Free software*: WeeChat is released under https://www.gnu.org/licenses/gpl-3.0.html[GPLv3].
2014-03-05 06:44:10 -05:00
2019-02-24 10:37:19 -05:00
pass:[<p align="center">] image:https://weechat.org/media/images/screenshots/weechat/medium/weechat_2013-04-27_phlux_shadow.png[align="center"] pass:[</p>]
2014-03-06 03:52:01 -05:00
2018-10-22 20:34:56 -04:00
On WeeChat's website you can find https://weechat.org/about/screenshots/[more screenshots].
2016-02-26 13:28:13 -05:00
2014-03-05 06:44:10 -05:00
== Install
=== Dependencies
Following packages are *required*:
* CMake
* libncurses
* libcurl
* zlib
* libgcrypt
Following packages are optional:
* for i18n: gettext
* for SSL: gnutls, ca-certificates
2019-01-27 08:59:22 -05:00
* for spell checking: aspell or enchant
2017-09-03 15:41:29 -04:00
* for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript), php
2016-05-15 02:56:45 -04:00
* for building doc and man page: asciidoctor
2014-08-05 01:36:01 -04:00
* for building tests: C++ compiler, CppUTest
2014-03-05 06:44:10 -05:00
For a complete list of dependencies and versions recommended, please look at
2014-12-13 03:16:09 -05:00
https://weechat.org/files/doc/devel/weechat_user.en.html#dependencies[user's guide].
2014-03-05 06:44:10 -05:00
=== Compile
2018-11-29 17:18:55 -05:00
WeeChat can be built with https://cmake.org/[CMake] (recommended) or autotools.
2014-03-05 06:44:10 -05:00
[NOTE]
2015-12-03 01:46:38 -05:00
Only CMake is officially supported to build WeeChat. You should only use
2015-12-02 22:03:11 -05:00
autotools if you are not able to use CMake. +
Building with autotools requires more dependencies and is slower than with CMake.
2014-03-05 06:44:10 -05:00
2017-07-03 13:41:01 -04:00
* Installation in system directories (requires _root_ privileges):
2017-07-02 01:28:05 -04:00
----
$ mkdir build
$ cd build
$ cmake ..
$ make
2017-07-03 13:41:01 -04:00
$ sudo make install
2017-07-02 01:28:05 -04:00
----
2017-07-03 13:41:01 -04:00
* Installation in custom directory (for example your home):
2017-07-02 01:28:05 -04:00
2014-03-05 06:44:10 -05:00
----
$ mkdir build
$ cd build
2015-05-17 02:48:54 -04:00
$ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory
2014-03-05 06:44:10 -05:00
$ make
2017-07-02 01:28:05 -04:00
$ make install
2014-03-05 06:44:10 -05:00
----
For more information or installation with autotools, please look at
2014-12-13 03:16:09 -05:00
https://weechat.org/files/doc/devel/weechat_user.en.html#compile_with_autotools[user's guide].
2009-05-15 17:03:35 -04:00
2017-07-23 09:33:47 -04:00
=== Run tests
Following packages are *required* to compile tests:
* libcpputest-dev
* C++ compiler
Tests must be enabled when compiling WeeChat:
----
$ cmake .. -DENABLE_TESTS=ON
----
They can be launched after compilation from the build directory:
----
$ ctest -V
----
2013-11-06 15:40:46 -05:00
== Copyright
2015-12-03 01:46:38 -05:00
2020-01-04 04:41:26 -05:00
Copyright (C) 2003-2020 Sébastien Helleu <flashcode@flashtux.org>
2003-09-27 06:01:11 -04:00
2010-06-22 13:46:28 -04:00
This file is part of WeeChat, the extensible chat client.
WeeChat is free software; you can redistribute it and/or modify
2003-09-27 06:01:11 -04:00
it under the terms of the GNU General Public License as published by
2007-07-02 08:25:13 -04:00
the Free Software Foundation; either version 3 of the License, or
2003-09-27 06:01:11 -04:00
(at your option) any later version.
2010-06-22 13:46:28 -04:00
WeeChat is distributed in the hope that it will be useful,
2003-09-27 06:01:11 -04:00
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
2018-11-29 17:16:07 -05:00
along with WeeChat. If not, see <https://www.gnu.org/licenses/>.