2018-08-23 21:50:29 +00:00
|
|
|
|
poezio
|
|
|
|
|
======
|
2010-07-08 21:31:02 +00:00
|
|
|
|
|
2016-03-09 17:03:02 +00:00
|
|
|
|
Homepage: https://poez.io
|
2015-02-07 19:34:04 +00:00
|
|
|
|
|
2019-02-14 15:19:11 +00:00
|
|
|
|
Forge Page: https://lab.louiz.org/poezio/poezio
|
2010-01-10 20:14:17 +00:00
|
|
|
|
|
2010-11-15 11:59:09 +00:00
|
|
|
|
Poezio is a console Jabber/XMPP client. Its goal is to use anonymous
|
2011-01-12 20:36:27 +00:00
|
|
|
|
connections to simply let the user join MultiUserChats. This way, the user
|
2010-06-08 23:39:07 +00:00
|
|
|
|
doesn't have to create a Jabber account, exactly like people are using
|
2011-01-12 20:36:27 +00:00
|
|
|
|
IRC. Poezio's commands are designed to be (if possible) like commonly
|
|
|
|
|
used IRC clients (weechat, irssi, etc).
|
2013-06-28 10:50:46 +00:00
|
|
|
|
|
2010-10-04 01:45:16 +00:00
|
|
|
|
Since version 0.7, poezio can handle real Jabber accounts along with
|
2013-06-28 10:50:46 +00:00
|
|
|
|
roster and one-to-one conversations, making it a full-featured console
|
2010-10-04 01:45:16 +00:00
|
|
|
|
Jabber client, but still MultiUserChats-centered.
|
2013-06-28 10:50:46 +00:00
|
|
|
|
In the future, poezio should implement at a 100% level all XEP related to
|
2010-11-15 11:59:09 +00:00
|
|
|
|
MUCs, especially XEP 0045.
|
2010-01-10 20:14:17 +00:00
|
|
|
|
|
2018-08-23 21:50:29 +00:00
|
|
|
|
Install
|
|
|
|
|
=======
|
2013-06-28 10:50:46 +00:00
|
|
|
|
|
2018-08-13 20:38:01 +00:00
|
|
|
|
You need python 3.5 or higher (preferably the latest) and the associated devel
|
2014-11-30 15:12:16 +00:00
|
|
|
|
package, to build C modules, and the slixmpp python library.
|
|
|
|
|
You also need aiodns if you want SRV record support.
|
2013-06-28 10:50:46 +00:00
|
|
|
|
|
|
|
|
|
Additionally, you’ll need sphinx to build the documentation pages.
|
|
|
|
|
To read the documentation without these dependancies just read the rst
|
|
|
|
|
files in the doc/source/ directory or the generated documentation on the
|
|
|
|
|
website.
|
2010-01-31 19:01:18 +00:00
|
|
|
|
|
2011-04-16 23:47:54 +00:00
|
|
|
|
The simplest way to have up-to-date dependencies and to be able to test
|
2015-02-07 19:34:04 +00:00
|
|
|
|
this developement version is to use the ``update.sh`` script that downloads
|
2015-02-26 10:40:17 +00:00
|
|
|
|
them, places them in the right directory, and builds the C module.
|
2011-04-16 23:47:54 +00:00
|
|
|
|
|
2015-02-26 10:40:17 +00:00
|
|
|
|
You can then launch poezio with
|
2010-01-31 19:01:18 +00:00
|
|
|
|
|
2015-02-07 19:34:04 +00:00
|
|
|
|
::
|
2011-11-08 04:14:39 +00:00
|
|
|
|
|
2015-02-07 19:34:04 +00:00
|
|
|
|
$ ./launch.sh
|
2011-11-08 04:14:39 +00:00
|
|
|
|
|
2015-02-07 19:34:04 +00:00
|
|
|
|
you can now simply launch ``poezio``
|
2010-01-31 19:01:18 +00:00
|
|
|
|
|
2013-06-28 10:50:46 +00:00
|
|
|
|
You can edit the configuration file which is located in
|
2015-02-07 19:34:04 +00:00
|
|
|
|
``~/.config/poezio/poezio.cfg`` by default, and you will have to copy
|
|
|
|
|
and edit ``data/default_config.cfg`` if you want to edit the config before
|
|
|
|
|
the first launch. The default config file is fully commented, but you can
|
2013-06-28 10:50:46 +00:00
|
|
|
|
also read the “Configuration” documentation page which has links between
|
|
|
|
|
options and longer descriptions.
|
2010-01-31 19:01:18 +00:00
|
|
|
|
|
2013-06-28 10:50:46 +00:00
|
|
|
|
Please see the online documentation for more information on installing,
|
2016-03-09 17:03:02 +00:00
|
|
|
|
configuring or using poezio: https://doc.poez.io/
|
2010-01-31 19:01:18 +00:00
|
|
|
|
|
2011-01-12 20:36:27 +00:00
|
|
|
|
If you still have questions, or if you're lost, don't hesitate to come
|
2010-10-04 01:45:16 +00:00
|
|
|
|
talk to us directly on our Jabber chat room (see Contact section).
|
|
|
|
|
|
2013-06-28 10:50:46 +00:00
|
|
|
|
Please DO report any bug you encounter and ask for any feature you want
|
|
|
|
|
(we may implement it or not, but it’s always better to ask).
|
2010-01-31 19:01:18 +00:00
|
|
|
|
|
2018-08-23 21:50:29 +00:00
|
|
|
|
Authors
|
|
|
|
|
=======
|
2010-01-10 20:14:17 +00:00
|
|
|
|
|
2015-02-07 19:34:04 +00:00
|
|
|
|
- Florent Le Coz (louiz’) <louiz@louiz.org> (developer)
|
|
|
|
|
- Mathieu Pasquet (mathieui) <mathieui@mathieui.net> (developer)
|
2018-08-13 20:25:14 +00:00
|
|
|
|
- Emmanuel Gil Peyrot (Link Mauve) <linkmauve@linkmauve.fr> (developer)
|
2011-10-16 19:55:14 +00:00
|
|
|
|
|
2018-08-23 21:50:29 +00:00
|
|
|
|
Contact/support
|
|
|
|
|
===============
|
2015-02-07 19:34:04 +00:00
|
|
|
|
|
|
|
|
|
Jabber ChatRoom: `poezio@muc.poez.io <xmpp:poezio@muc.poez.io?join>`_
|
|
|
|
|
|
2019-02-14 15:19:11 +00:00
|
|
|
|
Report a bug: https://lab.louiz.org/poezio/poezio/issues/new
|
2011-10-16 19:55:14 +00:00
|
|
|
|
|
2018-08-23 21:50:29 +00:00
|
|
|
|
License
|
|
|
|
|
=======
|
2015-02-07 19:34:04 +00:00
|
|
|
|
|
2010-01-10 20:14:17 +00:00
|
|
|
|
Poezio is Free Software.
|
|
|
|
|
(learn more: http://www.gnu.org/philosophy/free-sw.html)
|
|
|
|
|
|
2011-09-11 15:10:05 +00:00
|
|
|
|
Poezio is released under the zlib License.
|
2010-11-15 11:59:09 +00:00
|
|
|
|
Please read the COPYING file for details.
|
2010-01-10 20:14:17 +00:00
|
|
|
|
|
2010-11-15 11:59:09 +00:00
|
|
|
|
The artwork logo was made by Gaëtan Ribémont and released under
|
2010-02-02 03:42:55 +00:00
|
|
|
|
the Creative Commons BY license (http://creativecommons.org/licenses/by/2.0/)
|
|
|
|
|
|
2011-10-16 19:53:48 +00:00
|
|
|
|
|
2018-08-23 21:50:29 +00:00
|
|
|
|
Hacking
|
|
|
|
|
=======
|
2013-06-28 10:50:46 +00:00
|
|
|
|
|
2015-02-07 19:34:04 +00:00
|
|
|
|
If you want to contribute, you will be welcome on
|
|
|
|
|
`poezio@muc.poez.io <xmpp:poezio@muc.poez.io?join>`_ to announce your
|
|
|
|
|
ideas, what you are going to do, or to seek help if you have trouble
|
|
|
|
|
understanding some of the code.
|
|
|
|
|
|
2018-08-23 21:50:29 +00:00
|
|
|
|
The preferred way to submit changes is through a merge request on gitlab,
|
|
|
|
|
at https://lab.louiz.org/poezio/poezio, but we also accept contributions
|
|
|
|
|
on github, or with a simple “please fetch my code on my personal git
|
|
|
|
|
repository hosted somewhere”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Thanks
|
|
|
|
|
======
|
2013-06-28 10:50:46 +00:00
|
|
|
|
|
2015-02-07 19:34:04 +00:00
|
|
|
|
- People:
|
|
|
|
|
- Todd Eisenberger - Plugin system and OTR support
|
|
|
|
|
- Jérôme Parment (Manfraid) - Code, testing
|
2016-10-15 16:56:06 +00:00
|
|
|
|
- Akim Sadaoui - Code
|
|
|
|
|
- Florian Duraffourg - Code
|
|
|
|
|
- Frédéric Meynadier - Code
|
|
|
|
|
- Georg Lukas - Code
|
|
|
|
|
- Johannes Krude - Code
|
|
|
|
|
- Łabędź - Code
|
|
|
|
|
- Lasse Aagren - Code
|
|
|
|
|
- Lancelot SIX - Code
|
|
|
|
|
- Luke Marlin - Code
|
2018-08-05 12:00:09 +00:00
|
|
|
|
- Maxime Buquet - Code
|
2016-10-15 16:56:06 +00:00
|
|
|
|
- Nicolas Braud-Santoni - Code
|
2015-02-07 19:34:04 +00:00
|
|
|
|
- Perdu - Code
|
|
|
|
|
- Eijebong - Code
|
2015-07-31 21:03:42 +00:00
|
|
|
|
- Gaëtan Ribémont - Logo design
|
2015-02-07 19:34:04 +00:00
|
|
|
|
- Ovart - Testing
|
|
|
|
|
- Koshie - Donation
|
|
|
|
|
- Gapan - Makefile
|
|
|
|
|
- FlashCode (weechat dev) - Useful advices on how to use ncurses efficiently
|
|
|
|
|
- And all the people using and testing poezio, and especially the ones present
|
|
|
|
|
on the jabber chatroom doing bug reports and/or feature requests.
|