root/trunk/README.html

Revision 9850, 4.7 kB (checked in by jim++, 2 months ago)

* cleaner configure result
* configure --help to show disable message when --disable-FEATURES (we can use disable or enable
for each one AFAIK)
* Add dbus compile time requirement to README.html
Line 
1<!DOCTYPE html
2    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5<head>
6 <title>Gajim - Read Me</title>
7</head>
8<body>
9
10<h1>Gajim Read Me</h1>
11
12<p>
13Welcome to Gajim and thank you for trying out our client.
14</p>
15
16<h2>Runtime Requirements</h2>
17<ul>
18<li>python2.4 or higher</li>
19<li>pygtk2.8 or higher</li>
20<li>python-libglade</li>
21<li>pysqlite2 (if you have python 2.5, you already have this)</li>
22</ul>
23
24<p>
25<strong>Note to packagers</strong>
26Gajim is a GTK+ app that loves GNOME. You can do 'make' so you don't require gnomepythonextras (aka gnome-python-desktop) which is gnome dep, but you will miss gnomekeyring integration.
27</p>
28
29<h2>Optional Runtime Requirements</h2>
30<ul>
31<li><a href="http://pyopenssl.sourceforge.net/">PyOpenSSL</a> (python-pyopenssl package in Debian) for <em>secure</em> SSL/TLS. Python's default SSL is insecure, so this package is highly recommended!</li>
32<li>python-crypto to enable End to end encryption</li>
33<li>For zeroconf (bonjour), the "enable link-local messaging" checkbox, you need dbus-glib, python-avahi</li>
34<li>dnsutils (or whatever package provides the nslookup binary) for SRV support; if you don't know what that is, you don't need it</li>
35<li>gtkspell and aspell-LANG where lang is your locale eg. en, fr etc</li>
36<li>GnomePythonExtras 2.10 or above (aka gnome-python-desktop) so you can avoid compiling trayicon and gtkspell</li>
37<li>gnome-python-desktop (for GnomeKeyring support)</li>
38<li>notification-daemon or notify-python (and D-Bus) to get cooler popups</li>
39<li>D-Bus running to have gajim-remote working</li>
40<li>python-dbus bindings</li>
41<li>python-sexy to have clickable URLs in chat windows</li>
42</ul>
43
44<p>
45Some distributions also split too much python standard library.
46I know SUSE does. In such distros you also need python-xml
47the xml lib that *comes* with python and not pyxml or whatever.
48</p>
49
50<h2>Compile-time Requirements</h2>
51<ul>
52<li>python-dev</li>
53<li>python-gtk2-dev</li>
54<li>libgtk2.0-dev aka. gtk2-devel</li>
55<li>libxss-dev (for idle detection module; some distributions such as Debian split xscreensaver)</li>
56<li>libgtkspell-dev     (for the gtkspell module)</li>
57<li>libdbus-1-dev       (for the remote control module)</li>
58<li>intltool</li>
59</ul>
60
61<p>
62<strong>NOTE:</strong>
63If you still have problems compiling, you may want to try removing the gtk1 series of the above dependencies.
64</p>
65
66<h2>Installation Procedure</h2>
67<ol>
68<li>tar jxvf gajim-version.tar.bz2</li>
69<li>cd gajim</li>
70<li>./configure</li>
71<li>make (builds all modules)</li>
72<li>su -c make install</li>
73</ol>
74
75<p>
76To specify what modules to build do:
77make help
78</p>
79
80<p>
81To specify where to install do:
82su -c make PREFIX=custom_path install
83</p>
84
85<h2>Running Gajim</h2>
86<p>
87Just do <em>gajim</em> or you can run Gajim from your GNOME/XFCE/KDE/whatever menus.<br/><br/>
88
89or if you didn't 'make install' you can also run from gajim folder with
90<em>./launch.sh</em></p>
91<hr />
92<h3>Note for svn users</h3>
93You will need GNU autotools in order to install Gajim from svn. This includes:
94<ul>
95<li>automake &gt;= 1.8 </li>
96<li>autoconf &gt;= 2.59 </li>
97<li>libtool</li>
98<li>intltool-0.35.0 </li>
99<li>pkgconfig &gt;= 0.19</li>
100</ul>
101</p>
102steps to compile gajim:
103<pre>
104    $ sh autogen.sh
105    $ ./configure
106    $ make
107</pre>
108Alternatively, if you don't want to install all these packages, you can get a nightly snapshot from <a href="http://www.gajim.org/downloads/snap/">here</a> and procede as usual:
109<pre>
110    $ ./configure
111    $ make
112</pre>
113<h2>Uninstallation Procedure</h2>
114<p>
115su -c make uninstall<br/>
116this will try to remove Gajim from the default directories.
117If you want to remove it from custom directory provide it as:<br/>
118make PREFIX=custom_path uninstall
119</p>
120
121<h2>Miscellaneous</h2>
122<h3>XML &amp; Debugging</h3>
123<p>
124If you want to see the xml stanzas and/or help us debugging
125you're advised to enable verbose via advanced configuration window.
126If you don't want to make this permanent, execute gajim with --verbose
127everytime you want to have verbose output.
128</p>
129
130<h3>FAQ/Wiki</h3>
131<p>
132FAQ can be found at <a href="http://trac.gajim.org/wiki/GajimFaq">http://trac.gajim.org/wiki/GajimFaq</a><br/>
133Wiki can be found at <a href="http://trac.gajim.org/wiki">http://trac.gajim.org/wiki</a>
134</p>
135
136
137<p>
138That is all, <strong>enjoy!</strong>
139</p>
140
141<p>
142<br/>
143<br/>
144<br/>
145(C) 2003-2006<br/>
146The Gajim Team<br/>
147http://gajim.org<br/>
148<br/>
149<br/>
150
151PS.
152We use original art and parts of sounds and other art from Psi, Gossip,
153Gnomebaker, Gaim and some icons from various gnome-icons
154(mostly Dropline Etiquette) we found at art.gnome.org
155If you think we're violating a license please inform us. Thank you.
156</p>
157</body></html>
Note: See TracBrowser for help on using the browser.