]> jfr.im git - irc/weechat/qweechat.git/blob - INSTALL
Decode buffer name when inserting (patch #8050)
[irc/weechat/qweechat.git] / INSTALL
1 QWeeChat installation
2 =====================
3
4 Required to run QWeeChat:
5 - Python 2.x >= 2.6
6 - PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)
7
8
9 Run without install
10 -------------------
11
12 Extract files from archive and run qweechat.py:
13
14 ----------------------------------------
15 $ tar xvzf qweechat-x.y.tar.gz
16 $ cd qweechat-x.y
17 $ python src/qweechat/qweechat.py
18 ----------------------------------------
19
20
21 Run with install
22 ----------------
23
24 Extract files from archive and install using script 'setup.py':
25
26 ----------------------------------------
27 $ tar xvzf qweechat-x.y.tar.gz
28 $ cd qweechat-x.y
29 ----------------------------------------
30
31 To install in your home:
32
33 ----------------------------------------
34 $ python setup.py install --home=~/qweechat
35 ----------------------------------------
36
37 To install in system directories (as root):
38
39 ----------------------------------------
40 # python setup.py install
41 ----------------------------------------
42
43
44 WeeChat setup
45 -------------
46
47 You have to add a relay port in WeeChat, for example on port 1234:
48
49 ----------------------------------------
50 /relay add weechat 1234
51 /set relay.network.password "mypass"
52 ----------------------------------------
53
54
55 Connect to WeeChat
56 ------------------
57
58 In QWeeChat, click on connect and enter fields:
59
60 * 'server': the IP address or hostname of your machine with WeeChat running
61 * 'port': the relay port (defined in WeeeChat)
62 * 'password': the relay password (defined in WeeChat)
63
64 Options can be changed in file '~/.qweechat/qweechat.conf'.
65
66
67 See AUTHORS for support, feel free to contact us for any problem.