README.html 4.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
 <title>Gajim - Read Me</title>
</head>
<body>

<h1>Gajim Read Me</h1>

<p>
Welcome to Gajim and thank you for trying out our client.
</p>

<h2>Runtime Requirements</h2>
<ul>
<li>python2.4 or higher</li>
<li>pygtk2.6 or higher</li>
<li>python-libglade</li>
<li>pysqlite2 (if you have python 2.5, you already have this)</li>
</ul>

<p>
<strong>Note to packagers</strong>
jimpp's avatar
jimpp committed
26
Gajim 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 28 29 30
</p>

<h2>Optional Runtime Requirements</h2>
<ul>
31
<li>For zeroconf (bonjour), the "enable link-local messaging" checkbox, you need dbus-glib, python-avahi</li>
32 33 34 35 36
<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>
<li>gtkspell and aspell-LANG where lang is your locale eg. en, fr etc</li>
<li>GnomePythonExtras 2.10 or above (aka gnome-python-desktop) so you can avoid compiling trayicon and gtkspell</li>
<li>gnome-python-desktop (for GnomeKeyring support)</li>
<li>notification-daemon or notify-python (and D-Bus) to get cooler popups</li>
37 38
<li>D-Bus running to have gajim-remote working</li>
<li>python-dbus bindings</li>
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
</ul>

<p>
Some distributions also split too much python standard library.
I know SUSE does. In such distros you also need python-xml
the xml lib that *comes* with python and not pyxml or whatever.
</p>

<h2>Compile-time Requirements</h2>
<ul>
<li>python-dev</li>
<li>python-gtk2-dev</li>
<li>libgtk2.0-dev aka. gtk2-devel</li>
<li>libxss-dev (for idle detection module; some distributions such as Debian split xscreensaver)</li>
<li>libgtkspell-dev	(for the gtkspell module)</li>
<li>intltool</li>
</ul>

<p>
<strong>NOTE:</strong>
If you still have problems compiling, you may want to try removing the gtk1 series of the above dependencies.
</p>

<h2>Installation Procedure</h2>
<ol>
<li>tar jxvf gajim-version.tar.bz2</li>
65 66 67 68
<li>cd gajim</li>
<li>./configure</li>
<li>make (builds all modules)</li>
<li>su -c make install</li>
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
</ol>

<p>
To specify what modules to build do:
make help
</p>

<p>
To specify where to install do:
su -c make PREFIX=custom_path install
</p>

<h2>Running Gajim</h2>
<p>
Just do <em>gajim</em> or you can run Gajim from your GNOME/XFCE/KDE/whatever menus.<br/><br/>

or if you didn't 'make install' you can also run from gajim folder with
nkour's avatar
nkour committed
86 87
<em>./launch.sh</em></p>
<hr />
88 89 90 91 92 93 94
<h3>Note for svn users</h3>
You will need GNU autotools in order to install Gajim from svn. This includes: 
<ul>
<li>automake &gt;= 1.8 </li>
<li>autoconf &gt;= 2.59 </li>
<li>libtool</li>
<li>intltool-0.35.0 </li>
95
<li>pkgconfig &gt;= 0.19</li>
96
</ul>
97
</p>
98 99 100 101 102 103
steps to compile gajim:
<pre>
    $ sh autogen.sh
    $ ./configure
    $ make
</pre>
104 105 106 107 108
Alternatively, 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:
<pre>
    $ ./configure
    $ make
</pre>
109 110 111 112 113 114 115 116 117
<h2>Uninstallation Procedure</h2>
<p>
su -c make uninstall<br/>
this will try to remove Gajim from the default directories.
If you want to remove it from custom directory provide it as:<br/>
make PREFIX=custom_path uninstall
</p>

<h2>Miscellaneous</h2>
nkour's avatar
nkour committed
118
<h3>XML &amp; Debugging</h3>
119 120 121 122 123 124 125 126 127
<p>
If you want to see the xml stanzas and/or help us debugging 
you're advised to enable verbose via advanced configuration window.
If you don't want to make this permanent, execute gajim with --verbose
everytime you want to have verbose output.
</p>

<h3>FAQ/Wiki</h3>
<p>
nkour's avatar
nkour committed
128
FAQ can be found at <a href="http://trac.gajim.org/wiki/GajimFaq">http://trac.gajim.org/wiki/GajimFaq</a><br/>
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
Wiki can be found at <a href="http://trac.gajim.org/wiki">http://trac.gajim.org/wiki</a>
</p>


<p>
That is all, <strong>enjoy!</strong>
</p>

<p>
<br/>
<br/>
<br/>
(C) 2003-2006<br/>
The Gajim Team<br/>
http://gajim.org<br/>
<br/>
<br/>

PS.
We use original art and parts of sounds and other art from Psi, Gossip,
Gnomebaker, Gaim and some icons from various gnome-icons
(mostly Dropline Etiquette) we found at art.gnome.org
If you think we're violating a license please inform us. Thank you.
</p>
</body></html>