]>
Commit | Line | Data |
---|---|---|
6f4e0369 SH |
1 | = QWeeChat |
2 | :author: Sébastien Helleu | |
3 | :email: flashcode@flashtux.org | |
4 | :lang: en | |
5 | ||
6 | ||
7 | QWeeChat is a Qt remote GUI for WeeChat written in Python. | |
8 | ||
9036a59a | 9 | Homepage: https://weechat.org/ |
6f4e0369 | 10 | |
661b2993 SH |
11 | image:https://travis-ci.org/weechat/qweechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/qweechat"] |
12 | ||
6f4e0369 SH |
13 | |
14 | == Features | |
15 | ||
16 | * Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others). | |
17 | * Free software, released under GPLv3. | |
18 | ||
fa2b812c | 19 | image::https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png[align="center"] |
6f4e0369 SH |
20 | |
21 | == Install | |
22 | ||
23 | === Dependencies | |
24 | ||
25 | Following packages are *required*: | |
26 | ||
27 | * WeeChat (version >= 0.3.7) on local or remote machine, with relay plugin | |
28 | enabled and listening on a port with protocol "weechat" | |
29 | * Python 2.x >= 2.6 | |
30 | * PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4) | |
31 | ||
77df9d06 | 32 | === Install via source distribution |
6f4e0369 SH |
33 | |
34 | ---- | |
77df9d06 | 35 | $ python setup.py install |
6f4e0369 SH |
36 | ---- |
37 | ||
38 | == WeeChat setup | |
39 | ||
40 | You have to add a relay port in WeeChat, for example on port 1234: | |
41 | ||
42 | ---- | |
43 | /set relay.network.password "mypass" | |
44 | /relay add weechat 1234 | |
45 | ---- | |
46 | ||
47 | == Connect to WeeChat | |
48 | ||
49 | In QWeeChat, click on connect and enter fields: | |
50 | ||
51 | * 'server': the IP address or hostname of your machine with WeeChat running | |
52 | * 'port': the relay port (defined in WeeChat) | |
53 | * 'password': the relay password (defined in WeeChat) | |
54 | ||
55 | Options can be changed in file '~/.qweechat/qweechat.conf'. | |
56 | ||
57 | == Copyright | |
58 | ||
bcea4dd1 | 59 | Copyright (C) 2011-2016 Sébastien Helleu <flashcode@flashtux.org> |
6f4e0369 SH |
60 | |
61 | This file is part of QWeeChat, a Qt remote GUI for WeeChat. | |
62 | ||
63 | QWeeChat is free software; you can redistribute it and/or modify | |
64 | it under the terms of the GNU General Public License as published by | |
65 | the Free Software Foundation; either version 3 of the License, or | |
66 | (at your option) any later version. | |
67 | ||
68 | QWeeChat is distributed in the hope that it will be useful, | |
69 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
70 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
71 | GNU General Public License for more details. | |
72 | ||
73 | You should have received a copy of the GNU General Public License | |
74 | along with QWeeChat. If not, see <http://www.gnu.org/licenses/>. |