2014-03-05 06:44:10 -05:00
|
|
|
= WeeChat
|
|
|
|
|
: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
|
|
|
|
2015-11-28 03:05:43 -05:00
|
|
|
image:https://travis-ci.org/weechat/weechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/weechat"]
|
|
|
|
|
image:https://img.shields.io/badge/diaspora*-follow-blue.svg["Diaspora*", link="https://diasp.eu/u/weechat"]
|
|
|
|
|
image:https://img.shields.io/badge/google%2B-follow-blue.svg["Google+", link="https://plus.google.com/+WeeChat"]
|
|
|
|
|
image:https://img.shields.io/badge/devel%20blog-follow-blue.svg["Devel blog", link="http://dev.weechat.org/"]
|
2015-11-29 04:54:48 -05:00
|
|
|
image:https://img.shields.io/badge/slant-recommend-28acad.svg["Slant", link="http://www.slant.co/topics/1323/~irc-clients-for-linux"]
|
2015-11-29 04:55:26 -05:00
|
|
|
image:https://img.shields.io/badge/paypal-donate%20%E2%9D%A4-yellow.svg["Paypal", link="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4LSMSNLUAJWNS"]
|
2015-11-28 03:05:43 -05:00
|
|
|
|
2015-04-05 10:01:12 -04:00
|
|
|
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.
|
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
|
|
|
|
2014-03-05 06:44:10 -05:00
|
|
|
* Modular chat client with a lightweight core and optional plugins.
|
|
|
|
|
* Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & other).
|
|
|
|
|
* Multi-protocols architecture (mainly IRC).
|
|
|
|
|
* Compliant with IRC RFCs 1459, 2810, 2811, 2812 and 2813.
|
|
|
|
|
* Small, fast and very light.
|
2015-03-08 06:33:08 -04:00
|
|
|
* Customizable and extensible with plugins (C, Perl, Python, Ruby, Lua, Tcl,
|
|
|
|
|
Guile, Javascript).
|
2014-03-05 06:44:10 -05:00
|
|
|
* Fully documented and translated into several languages.
|
|
|
|
|
* Developed from scratch.
|
|
|
|
|
* Free software, released under GPLv3.
|
|
|
|
|
|
2015-03-25 16:54:13 -04:00
|
|
|
image::https://weechat.org/media/images/screenshots/weechat/medium/weechat_2013-04-27_phlux_shadow.png[align="center"]
|
2014-03-06 03:52:01 -05:00
|
|
|
|
2016-02-26 13:28:13 -05:00
|
|
|
Other screenshots are on https://weechat.org/about/screenshots/[this page].
|
|
|
|
|
|
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
|
|
|
|
|
* for spell checking: aspell
|
2015-03-08 06:33:08 -04:00
|
|
|
* for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript)
|
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
|
|
|
|
|
|
|
|
|
|
WeeChat can be built with http://cmake.org/[CMake] (recommended) or autotools.
|
|
|
|
|
|
|
|
|
|
[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
|
|
|
|
|
|
|
|
----
|
|
|
|
|
$ 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
|
|
|
|
|
$ make install (as root for installation in system directories)
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
2013-11-06 15:40:46 -05:00
|
|
|
== Copyright
|
2015-12-03 01:46:38 -05:00
|
|
|
|
2016-01-01 05:09:53 -05:00
|
|
|
Copyright (C) 2003-2016 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
|
2010-06-22 13:46:28 -04:00
|
|
|
along with WeeChat. If not, see <http://www.gnu.org/licenses/>.
|
