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