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