README.html

   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  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8 </head>
   9 <body>
  10
  11 <h1>Gajim Read Me</h1>
  12
  13 <p>Welcome to Gajim and thank you for trying out our client.</p>
  14
  15 <h2>Runtime Requirements</h2>
  16 <ul>
  17 <li>python2.5 or higher</li>
  18 <li>pygtk2.16 or higher</li>
  19 <li>pysqlite2 (if you have python 2.5, you already have this)</li>
  20 </ul>
  21
  22 <p><strong>Note to packagers</strong> 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.</p>
  23
  24 <h2>Optional Runtime Requirements</h2>
  25 <ul>
  26 <li><a href="http://pyopenssl.sourceforge.net/">PyOpenSSL</a> (python-pyopenssl package in Debian) (>=0.9) for <em>secure</em> SSL/TLS. Python's default SSL is insecure, so this package is highly recommended!</li>
  27 <li>python-crypto to enable End to end encryption</li>
  28 <li>For idle module, libxss library</li>
  29 <li>For zeroconf (bonjour), the "enable link-local messaging" checkbox, you need dbus-glib, python-avahi</li>
  30 <li>dnsutils (or whatever package provides the nslookup binary) for SRV support</li>
  31 <li>gtkspell and aspell-LANG where lang is your locale eg. en, fr etc</li>
  32 <li>gnome-python-desktop (for GnomeKeyring support)</li>
  33 <li>notification-daemon or notify-python (and D-Bus) to get cooler popups</li>
  34 <li>D-Bus running to have gajim-remote working. Some distributions split dbus-x11, which is needed for dbus to work with Gajim. Version >= 0.80 is required.</li>
  35 <li>python-dbus bindings (>=0.81)</li>
  36 <li>python-kerberos to use GSSAPI authentification. Note: version1.1 or higher is required</li>
  37 </ul>
  38
  39 <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>
  40
  41 <h2>Compile-time Requirements</h2>
  42 <ul>
  43 <li>python-dev</li>
  44 <li>python-gtk2-dev</li>
  45 <li>intltool (>= 0.40.1)</li>
  46 </ul>
  47
  48 <p><strong>NOTE:</strong> If you still have problems compiling, you may want to try removing the gtk1 series of the above dependencies.</p>
  49
  50 <h2>Installation Procedure</h2>
  51 <ol>
  52 <li>tar jxvf gajim-version.tar.bz2</li>
  53 <li>cd gajim</li>
  54 <li>./configure</li>
  55 <li>make (builds all modules)</li>
  56 <li>su -c make install</li>
  57 </ol>
  58
  59 <p>To specify what modules to build do:</p>
  60 <pre>
  61     make help
  62 </pre>
  63
  64 <p>To specify where to install do:</p>
  65 <pre>
  66     ./configure --prefix=custom_path
  67 </pre>
  68
  69 <h2>Running Gajim</h2>
  70 <p>Just do <em>gajim</em> or you can run Gajim from your GNOME/Xfce/KDE/whatever menus.<br/><br/>
  71 or if you use hg version and you didn't 'make install' you can also run from gajim folder with<em>./launch.sh</em></p>
  72 <hr />
  73 <h3>Note for hg users</h3>
  74 <p>You will need GNU autotools in order to install Gajim from svn. This includes:</p>
  75 <ul>
  76 <li>automake &gt;= 1.8 </li>
  77 <li>autoconf &gt;= 2.59 </li>
  78 <li>libtool</li>
  79 <li>intltool-0.40.1 </li>
  80 <li>pkgconfig &gt;= 0.19</li>
  81 </ul>
  82 <p>steps to compile gajim:</p>
  83 <pre>
  84     $ sh autogen.sh
  85     $ ./configure
  86     $ make
  87 </pre>
  88 <p>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:</p>
  89 <pre>
  90     $ ./configure
  91     $ make
  92 </pre>
  93 <h2>Uninstallation Procedure</h2>
  94 <pre>
  95     su -c make uninstall
  96 </pre>
  97 <p>this will try to remove Gajim from the default directories.
  98 If you want to remove it from custom directory provide it as:
  99 </p>
 100 <pre>
 101     ./configure --prefix=custom_path
 102     make uninstall
 103 </pre>
 104
 105 <h2>Miscellaneous</h2>
 106 <h3>XML &amp; Debugging</h3>
 107 <p>If you want to see the xml stanzas and/or help us debugging
 108 you're advised to enable verbose via advanced configuration window.
 109 If you don't want to make this permanent, execute gajim with --verbose
 110 everytime you want to have verbose output.</p>
 111
 112 <h3>FAQ/Wiki</h3>
 113 <p>FAQ can be found at <a href="http://trac.gajim.org/wiki/GajimFaq">http://trac.gajim.org/wiki/GajimFaq</a><br/>
 114 Wiki can be found at <a href="http://trac.gajim.org/wiki">http://trac.gajim.org/wiki</a></p>
 115
 116
 117 <p>That is all, <strong>enjoy!</strong></p>
 118
 119 <p>
 120 <br/>
 121 <br/>
 122 <br/>
 123 (C) 2003-2010<br/>
 124 The Gajim Team<br/>
 125 http://gajim.org<br/>
 126 <br/>
 127 <br/>
 128
 129 PS.
 130 We use original art and parts of sounds and other art from Psi, Gossip,
 131 Gnomebaker, Gaim and some icons from various gnome-icons
 132 (mostly Dropline Etiquette) we found at art.gnome.org
 133 If you think we're violating a license please inform us. Thank you.</p>
 134 </body></html>