version of weechat using utf8proc
 
 
 
 
 
 
Vai al file
Sébastien Helleu 8560b09dad relay: add missing gcrypt lib in CMake and autotools files
This fixes build on Cygwin.
2020-04-15 22:50:27 +02:00
.github core: rename label "enhancement" to "feature" 2019-11-15 21:06:15 +01:00
cmake cmake: removed vendored FindPackageHandleStandardArgs 2020-04-11 09:48:20 +02:00
debian-devel debian: bump Standards-Version to 4.4.0 2019-12-08 08:22:45 +01:00
debian-stable core: update copyright dates 2020-01-04 10:41:26 +01:00
doc doc: revert arrows chars in relay protocol 2020-04-14 22:16:48 +02:00
icons cmake: rename internal variable SHAREDIR to DATAROOTDIR 2020-04-12 10:16:41 +02:00
po relay: add command "handshake" in weechat relay protocol and nonce to prevent replay attacks (closes #1474) 2020-04-14 21:38:12 +02:00
src relay: add missing gcrypt lib in CMake and autotools files 2020-04-15 22:50:27 +02:00
tests relay: add command "handshake" in weechat relay protocol and nonce to prevent replay attacks (closes #1474) 2020-04-14 21:38:12 +02:00
tools core: update copyright dates 2020-01-04 10:41:26 +01:00
.gitattributes core: remove obsolete directory from .gitattributes 2018-12-24 15:57:29 +01:00
.gitignore core: update build directories in .gitignore 2019-11-19 07:40:11 +01:00
.mailmap Restore e-mail already used in commits 2018-03-10 19:06:31 +01:00
.travis.yml work around broken travis environment variables 2019-07-31 20:46:02 +02:00
AUTHORS.adoc core: add contributor in AUTHORS.adoc (issue #1460) 2020-04-11 09:51:10 +02:00
CMakeLists.txt core: fix indentation 2020-04-12 10:17:03 +02:00
COPYING core: use https for links to GNU GPL license 2018-11-29 23:16:07 +01:00
ChangeLog.adoc relay: add command "handshake" in weechat relay protocol and nonce to prevent replay attacks (closes #1474) 2020-04-14 21:38:12 +02:00
Contributing.adoc core: replace "web site" by "website" 2018-11-04 21:32:35 +01:00
Makefile.am core: remove file cmake/FindPackageHandleStandardArgs.cmake from top Makefile.am (issue #1460) 2020-04-11 09:50:33 +02:00
README.adoc core: update copyright dates 2020-01-04 10:41:26 +01:00
ReleaseNotes.adoc relay: add command "handshake" in weechat relay protocol and nonce to prevent replay attacks (closes #1474) 2020-04-14 21:38:12 +02:00
autogen.sh core: update copyright dates 2020-01-04 10:41:26 +01:00
config.h.cmake cmake: fix bugged WEECHAT_SHAREDIR definition exposed by DATAROOTDIR rename 2020-04-12 10:16:41 +02:00
configure.ac core: fix C++ compiler flags with autotools 2020-03-22 11:09:27 +01:00
version.sh Version 2.9-dev 2020-03-29 09:58:29 +02:00
weechat.cygport.in core: remove directory usr/share/applications/ from cygport file 2020-03-29 11:55:20 +02:00
weechat.desktop core: add German translations in weechat.desktop 2019-10-08 20:54:25 +02:00
weechat.pc.in core: fix typo: Weechat -> WeeChat 2019-03-17 18:34:21 +01:00
weechat.spec Version 2.8 2020-03-29 09:39:36 +02:00

README.adoc

:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en


pass:[<p align="center">] image:https://weechat.org/media/images/weechat_logo_large.png[align="center"] pass:[</p>]

image:https://img.shields.io/badge/diaspora*-follow-blue.svg["Diaspora*", link="https://diasp.eu/u/weechat"]
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"]
image:https://img.shields.io/badge/devel%20blog-follow-blue.svg["Devel blog", link="https://blog.weechat.org/"]
image:https://img.shields.io/badge/slant-recommend-28acad.svg["Slant", link="https://www.slant.co/topics/1323/~best-irc-clients-for-linux"]
image:https://img.shields.io/badge/help-donate%20%E2%9D%A4-ff69b4.svg["Donate", link="https://weechat.org/donate/"]

image:https://travis-ci.org/weechat/weechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/weechat"]
image:https://codecov.io/gh/weechat/weechat/branch/master/graph/badge.svg["Code coverage", link="https://codecov.io/gh/weechat/weechat"]

*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.

Homepage: https://weechat.org/

== Features

* *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.
* *Multi-platform*: WeeChat runs on GNU/Linux, *BSD, GNU/Hurd, Haiku, macOS and Windows (Bash/Ubuntu and Cygwin).
* *Multi-protocols*: WeeChat is designed to support multiple protocols by plugins, like IRC.
* *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].
* *Small, fast and very light*: the core is and should stay as light and fast as possible.
* *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.
* *Developed from scratch*: WeeChat was built from scratch and is not based on any other client.
* *Free software*: WeeChat is released under https://www.gnu.org/licenses/gpl-3.0.html[GPLv3].

pass:[<p align="center">] image:https://weechat.org/media/images/screenshots/weechat/medium/weechat_2013-04-27_phlux_shadow.png[align="center"] pass:[</p>]

On WeeChat's website you can find https://weechat.org/about/screenshots/[more screenshots].

== 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 or enchant
* for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript), php
* for building doc and man page: asciidoctor
* for building tests: C++ compiler, CppUTest

For a complete list of dependencies and versions recommended, please look at
https://weechat.org/files/doc/devel/weechat_user.en.html#dependencies[user's guide].

=== Compile

WeeChat can be built with https://cmake.org/[CMake] (recommended) or autotools.

[NOTE]
Only CMake is officially supported to build WeeChat. You should only use
autotools if you are not able to use CMake. +
Building with autotools requires more dependencies and is slower than with CMake.

* Installation in system directories (requires _root_ privileges):

----
$ mkdir build
$ cd build
$ cmake ..
$ make
$ sudo make install
----

* Installation in custom directory (for example your home):

----
$ mkdir build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory
$ make
$ make install
----

For more information or installation with autotools, please look at
https://weechat.org/files/doc/devel/weechat_user.en.html#compile_with_autotools[user's guide].

=== 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
----

== Copyright

Copyright (C) 2003-2020 Sébastien Helleu <flashcode@flashtux.org>

This file is part of WeeChat, the extensible chat client.

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.

WeeChat is distributed in the hope that it will be useful,
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
along with WeeChat.  If not, see <https://www.gnu.org/licenses/>.